rustdoc: The short description of #[doc(cfg(target_feature = ...))] shouldn't spell out "target feature" #49334

Activity

1. kennytm

   added

   T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.

   C-enhancementCategory: An issue proposing an enhancement or a PR with one.Category: An issue proposing an enhancement or a PR with one.

   on Mar 24, 2018
2. kennytm

   assigned

   QuietMisdreavus

   on Mar 24, 2018
3. QuietMisdreavus commented on Mar 27, 2018

   

   QuietMisdreavus

   on Mar 27, 2018

   Contributor

   More actions

   Notes to self:

   The issue at hand is the fact that the "short text" is overridden when the condition is combined with others. The target features are supposed to only show "avx" when they're by themselves, as shown in the OP of #48759. The offending snippet:

   rust/src/librustdoc/clean/cfg.rs

   Lines 410 to 419 in 31ae4f9

   	impl<'a> fmt::Display for ShortHtml<'a> {
   	fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
   	match *self.0 {
   	Cfg::Cfg(ref name, Some(ref vendor)) if name == &"target_feature" => {
   	write!(fmt, "<code>{}</code>", vendor)
   	},
   	ref cfg => write!(fmt, "{}", Html(cfg)),
   	}
   	}
   	}

   The easiest way to fix this is to never print "target feature", even in the long form, but that text is still valuable there.

   😄React with 😄1Reacted by kennytm
4. kennytm

   added a commit that references this issue on May 22, 2018

   Rollup merge of rust-lang#50875 - QuietMisdreavus:short-features, r=G…

   ...

   42b4c49
5. bors

   closed this as completedin #50875on May 22, 2018