Skip to content

Commit

Permalink
Rollup merge of rust-lang#113058 - GuillaumeGomez:improve-code-commen…
Browse files Browse the repository at this point in the history
…ts, r=notriddle

Add/improve code comments

Working on something else and did some small comments updates/adds.

r? `@notriddle`
  • Loading branch information
matthiaskrgr authored Jun 27, 2023
2 parents a144272 + 32f056c commit 3238a97
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/librustdoc/clean/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2371,7 +2371,7 @@ fn filter_tokens_from_list(
tokens
}

/// When inlining items, we merge its attributes (and all the reexports attributes too) with the
/// When inlining items, we merge their attributes (and all the reexports attributes too) with the
/// final reexport. For example:
///
/// ```ignore (just an example)
Expand Down
3 changes: 3 additions & 0 deletions src/librustdoc/clean/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -956,6 +956,8 @@ pub(crate) trait AttributesExt {
.filter_map(|attr| Cfg::parse(attr.meta_item()?).ok())
.fold(Cfg::True, |cfg, new_cfg| cfg & new_cfg)
} else if doc_auto_cfg_active {
// If there is no `doc(cfg())`, then we retrieve the `cfg()` attributes (because
// `doc(cfg())` overrides `cfg()`).
self.iter()
.filter(|attr| attr.has_name(sym::cfg))
.filter_map(|attr| single(attr.meta_item_list()?))
Expand Down Expand Up @@ -2387,6 +2389,7 @@ impl ImplKind {
#[derive(Clone, Debug)]
pub(crate) struct Import {
pub(crate) kind: ImportKind,
/// The item being re-exported.
pub(crate) source: ImportSource,
pub(crate) should_be_displayed: bool,
}
Expand Down
2 changes: 1 addition & 1 deletion tests/rustdoc/reexport-doc-hidden-inside-private.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// This test ensures that a re-export of `#[doc(hidden)]` item inside a private
// This test ensures that a re-export of `#[doc(hidden)]` item inside a private
// module will still be displayed (the re-export, not the item).

#![crate_name = "foo"]
Expand Down

0 comments on commit 3238a97

Please sign in to comment.