update doc comments

This commit is contained in:
lcnr 2023-07-20 11:26:22 +02:00
parent 2062f2ca82
commit 5c75bc5317
1 changed files with 17 additions and 10 deletions

View File

@ -184,18 +184,21 @@ pub(super) trait GoalKind<'tcx>:
impl_def_id: DefId, impl_def_id: DefId,
) -> QueryResult<'tcx>; ) -> QueryResult<'tcx>;
/// If the predicate contained an error, we want to avoid emitting unnecessary trait errors but /// If the predicate contained an error, we want to avoid emitting unnecessary trait
/// still want to emit errors for other trait goals. We have some special handling for this case. /// errors but still want to emit errors for other trait goals. We have some special
/// handling for this case.
/// ///
/// Trait goals always hold while projection goals never do. This is a bit arbitrary but prevents /// Trait goals always hold while projection goals never do. This is a bit arbitrary
/// incorrect normalization while hiding any trait errors. /// but prevents incorrect normalization while hiding any trait errors.
fn consider_error_guaranteed_candidate( fn consider_error_guaranteed_candidate(
ecx: &mut EvalCtxt<'_, 'tcx>, ecx: &mut EvalCtxt<'_, 'tcx>,
guar: ErrorGuaranteed, guar: ErrorGuaranteed,
) -> QueryResult<'tcx>; ) -> QueryResult<'tcx>;
/// A type implements an `auto trait` if its components do as well. These components /// A type implements an `auto trait` if its components do as well.
/// are given by built-in rules from [`instantiate_constituent_tys_for_auto_trait`]. ///
/// These components are given by built-in rules from
/// [`structural_traits::instantiate_constituent_tys_for_auto_trait`].
fn consider_auto_trait_candidate( fn consider_auto_trait_candidate(
ecx: &mut EvalCtxt<'_, 'tcx>, ecx: &mut EvalCtxt<'_, 'tcx>,
goal: Goal<'tcx, Self>, goal: Goal<'tcx, Self>,
@ -207,15 +210,19 @@ pub(super) trait GoalKind<'tcx>:
goal: Goal<'tcx, Self>, goal: Goal<'tcx, Self>,
) -> QueryResult<'tcx>; ) -> QueryResult<'tcx>;
/// A type is `Copy` or `Clone` if its components are `Sized`. These components /// A type is `Copy` or `Clone` if its components are `Sized`.
/// are given by built-in rules from [`instantiate_constituent_tys_for_sized_trait`]. ///
/// These components are given by built-in rules from
/// [`structural_traits::instantiate_constituent_tys_for_sized_trait`].
fn consider_builtin_sized_candidate( fn consider_builtin_sized_candidate(
ecx: &mut EvalCtxt<'_, 'tcx>, ecx: &mut EvalCtxt<'_, 'tcx>,
goal: Goal<'tcx, Self>, goal: Goal<'tcx, Self>,
) -> QueryResult<'tcx>; ) -> QueryResult<'tcx>;
/// A type is `Copy` or `Clone` if its components are `Copy` or `Clone`. These /// A type is `Copy` or `Clone` if its components are `Copy` or `Clone`.
/// components are given by built-in rules from [`instantiate_constituent_tys_for_copy_clone_trait`]. ///
/// These components are given by built-in rules from
/// [`structural_traits::instantiate_constituent_tys_for_copy_clone_trait`].
fn consider_builtin_copy_clone_candidate( fn consider_builtin_copy_clone_candidate(
ecx: &mut EvalCtxt<'_, 'tcx>, ecx: &mut EvalCtxt<'_, 'tcx>,
goal: Goal<'tcx, Self>, goal: Goal<'tcx, Self>,