about summary refs log tree commit diff
diff options
context:
space:
mode:
authorNoah Lev <camelidcamel@gmail.com>2021-09-29 11:43:14 -0700
committerNoah Lev <camelidcamel@gmail.com>2021-10-02 15:57:57 -0700
commit5f744f33f60f1961e756adf30606a08076350182 (patch)
treeeea3a559e05f4b90de2c8a265e4970d211881181
parent962e45144390d3f8b7482d5dfbc3d739881f514e (diff)
downloadrust-5f744f33f60f1961e756adf30606a08076350182.tar.gz
rust-5f744f33f60f1961e756adf30606a08076350182.zip
Explain `ResolvedPath` vs `hir::Path`
Co-authored-by: Joshua Nelson <github@jyn.dev>
-rw-r--r--src/librustdoc/clean/types.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index d259ed3cdfa..df6e030aeef 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -1376,7 +1376,7 @@ crate struct PolyTrait {
 crate enum Type {
     /// A named type, which could be a trait.
     ///
-    /// This is mostly Rustdoc's version of [`hir::Path`].
+    /// This is mostly Rustdoc's version of [`hir::Path`]. It has to be different because Rustdoc's [`PathSegment`] can contain cleaned generics.
     ResolvedPath { path: Path, did: DefId },
     /// A `dyn Trait` object: `dyn for<'a> Trait<'a> + Send + 'static`
     DynTrait(Vec<PolyTrait>, Option<Lifetime>),