diff options
| author | Eric Holk <ericholk@microsoft.com> | 2022-08-17 13:07:17 -0700 |
|---|---|---|
| committer | Eric Holk <ericholk@microsoft.com> | 2022-08-19 10:53:18 -0700 |
| commit | 8b7b1f773a4d97b9567eb5998b5e59a718ece9d7 (patch) | |
| tree | 8833584cc133d7a0c84ea7b2e43d792887627b18 | |
| parent | 9c20b2a8cc7588decb6de25ac6a7912dcef24d65 (diff) | |
| download | rust-8b7b1f773a4d97b9567eb5998b5e59a718ece9d7.tar.gz rust-8b7b1f773a4d97b9567eb5998b5e59a718ece9d7.zip | |
Minor syntax and formatting update to doc comment
The comment is on find_vtable_types_for_unsizing, but there is another unrelated typo fix as well.
| -rw-r--r-- | compiler/rustc_monomorphize/src/collector.rs | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/compiler/rustc_monomorphize/src/collector.rs b/compiler/rustc_monomorphize/src/collector.rs index 96bbf5802e7..82ef16a7f72 100644 --- a/compiler/rustc_monomorphize/src/collector.rs +++ b/compiler/rustc_monomorphize/src/collector.rs @@ -128,7 +128,7 @@ //! #### Unsizing Casts //! A subtle way of introducing neighbor edges is by casting to a trait object. //! Since the resulting fat-pointer contains a reference to a vtable, we need to -//! instantiate all object-save methods of the trait, as we need to store +//! instantiate all object-safe methods of the trait, as we need to store //! pointers to these functions even if they never get called anywhere. This can //! be seen as a special case of taking a function reference. //! @@ -1044,10 +1044,12 @@ fn should_codegen_locally<'tcx>(tcx: TyCtxt<'tcx>, instance: &Instance<'tcx>) -> /// them. /// /// For example, the source type might be `&SomeStruct` and the target type -/// might be `&SomeTrait` in a cast like: +/// might be `&dyn SomeTrait` in a cast like: /// +/// ```rust,ignore (not real code) /// let src: &SomeStruct = ...; -/// let target = src as &SomeTrait; +/// let target = src as &dyn SomeTrait; +/// ``` /// /// Then the output of this function would be (SomeStruct, SomeTrait) since for /// constructing the `target` fat-pointer we need the vtable for that pair. @@ -1068,8 +1070,10 @@ fn should_codegen_locally<'tcx>(tcx: TyCtxt<'tcx>, instance: &Instance<'tcx>) -> /// for the pair of `T` (which is a trait) and the concrete type that `T` was /// originally coerced from: /// +/// ```rust,ignore (not real code) /// let src: &ComplexStruct<SomeStruct> = ...; -/// let target = src as &ComplexStruct<SomeTrait>; +/// let target = src as &ComplexStruct<dyn SomeTrait>; +/// ``` /// /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair /// `(SomeStruct, SomeTrait)`. |
