Skip to content

Attribute documentation for cfg_attr - #159798

Open
kantnero wants to merge 4 commits into
rust-lang:mainfrom
kantnero:attribute-documentation
Open

Attribute documentation for cfg_attr#159798
kantnero wants to merge 4 commits into
rust-lang:mainfrom
kantnero:attribute-documentation

Conversation

@kantnero

@kantnero kantnero commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Documents the cfg_attr
Part of #157604

r? @GuillaumeGomez
cc @fmease @traviscross

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jul 23, 2026
@rustbot

rustbot commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

@rustbot

This comment has been minimized.

@rustbot rustbot added has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 23, 2026
@rust-log-analyzer

This comment has been minimized.

…c, expect, ignore, and used

Signed-off-by: Emmanuel Ugwu <emmanuelugwu121@gmail.com>
@kantnero
kantnero force-pushed the attribute-documentation branch from d5001d5 to 34f55b4 Compare July 23, 2026 22:25
@rustbot rustbot removed has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 23, 2026
@rust-log-analyzer

This comment has been minimized.

Signed-off-by: Emmanuel Ugwu <emmanuelugwu121@gmail.com>
@rust-log-analyzer

This comment has been minimized.

Signed-off-by: Emmanuel Ugwu <emmanuelugwu121@gmail.com>
@rust-log-analyzer

This comment has been minimized.

@fmease

fmease commented Jul 25, 2026

Copy link
Copy Markdown
Member

Meta note:

Instead of trying to add docs for more and more attributes at once in one PR, I think it would be more helpful & generally better to split your efforts into several smaller PRs going forward which each contain a small set of related attributes / just one attribute instead of a large mixed bag.

That would make it a lot easier for reviewers since they wouldn't have to wade through 100 comments like in #158664 and context-switch constantly within the same PR. Consequently, it would mean your PRs can get merged a lot faster.

Re. you closing #158664 I guess that was due to git / GitHub issues? In case it wasn't though, I want to say that it makes it harder to follow the progress & discussions for specific attributes since they're now spread across several PRs (one has 100 comments as I've already mentioned), esp. since there's no link from the old to the new PR.


In any case, thanks for working on this!

Signed-off-by: Emmanuel Ugwu <emmanuelugwu121@gmail.com>
@kantnero kantnero changed the title Attribute documentation for cfg_attr, path, feature, doc, should_panic, expect, ignore, and used Attribute documentation for cfg_attr Jul 30, 2026
@kantnero

Copy link
Copy Markdown
Contributor Author

@fmease @GuillaumeGomez Change this to document just one attr cfg_attr will send subsequent pr after this is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants