Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit df845c9

Browse files
committedFeb 26, 2025
Spruce up AttributeKind docs
- Remove dead link to `rustc_attr` crate. - Add link to `rustc_attr_parsing` crate. - Split up first paragraph so it looks better at crate-level summary
1 parent ac91805 commit df845c9

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed
 

‎compiler/rustc_attr_data_structures/src/attributes.rs

+8-5
Original file line numberDiff line numberDiff line change
@@ -138,13 +138,14 @@ impl Deprecation {
138138
}
139139
}
140140

141-
/// Attributes represent parsed, *built in*, inert attributes. That means,
142-
/// attributes that are not actually ever expanded.
143-
/// For more information on this, see the module docs on the rustc_attr_parsing crate.
141+
/// Represent parsed, *built in*, inert attributes.
142+
///
143+
/// That means attributes that are not actually ever expanded.
144+
/// For more information on this, see the module docs on the [`rustc_attr_parsing`] crate.
144145
/// They're instead used as markers, to guide the compilation process in various way in most every stage of the compiler.
145146
/// These are kept around after the AST, into the HIR and further on.
146147
///
147-
/// The word parsed could be a little misleading here, because the parser already parses
148+
/// The word "parsed" could be a little misleading here, because the parser already parses
148149
/// attributes early on. However, the result, an [`ast::Attribute`]
149150
/// is only parsed at a high level, still containing a token stream in many cases. That is
150151
/// because the structure of the contents varies from attribute to attribute.
@@ -153,7 +154,9 @@ impl Deprecation {
153154
/// the place where `must_use` is checked) little to no extra parsing or validating needs to
154155
/// happen.
155156
///
156-
/// For more docs, look in [`rustc_attr`](https://doc.rust-lang.org/stable/nightly-rustc/rustc_attr/index.html)
157+
/// For more docs, look in [`rustc_attr_parsing`].
158+
///
159+
/// [`rustc_attr_parsing`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_attr_parsing/index.html
157160
#[derive(Clone, Debug, HashStable_Generic, Encodable, Decodable, PrintAttribute)]
158161
pub enum AttributeKind {
159162
// tidy-alphabetical-start

0 commit comments

Comments
 (0)
Failed to load comments.