about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRune Tynan <runetynan@gmail.com>2022-01-13 14:43:32 -0500
committerRune Tynan <runetynan@gmail.com>2022-01-13 14:43:32 -0500
commitaafcbf1e70defb145542ec66a98d581c23899e76 (patch)
treecfda3059258f5c11c6196af01d3097f0a57ca5ad
parenta6aa3cb2c10c986eb231378e154766ce38f99a49 (diff)
downloadrust-aafcbf1e70defb145542ec66a98d581c23899e76.tar.gz
rust-aafcbf1e70defb145542ec66a98d581c23899e76.zip
Update comment to make it a FIXME
-rw-r--r--src/librustdoc/json/mod.rs6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/librustdoc/json/mod.rs b/src/librustdoc/json/mod.rs
index 0f80c8a5b4c..c95570c4b3b 100644
--- a/src/librustdoc/json/mod.rs
+++ b/src/librustdoc/json/mod.rs
@@ -171,8 +171,10 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> {
     /// the hashmap because certain items (traits and types) need to have their mappings for trait
     /// implementations filled out before they're inserted.
     fn item(&mut self, item: clean::Item) -> Result<(), Error> {
-        // We skip children of local blanket implementations, as we'll have already seen the actual
-        // generic impl, and the generated ones don't need documenting.
+        // FIXME(CraftSpider): We skip children of local blanket implementations, as we'll have
+        //     already seen the actual generic impl, and the generated ones don't need documenting.
+        //     This is necessary due to the visibility, return type, and self arg of the generated
+        //     impls not quite matching, and will no longer be necessary when the mismatch is fixed.
         let local_blanket_impl = match item.def_id {
             clean::ItemId::Blanket { impl_id, .. } => impl_id.is_local(),
             clean::ItemId::Auto { .. }