Skip to content

Generate documentation in rustc rustc_index::newtype_index macro #90839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 14, 2021
Merged

Generate documentation in rustc rustc_index::newtype_index macro #90839

merged 1 commit into from
Nov 14, 2021

Conversation

pierwill
Copy link
Contributor

The macro now documents all generated items. Documentation notes possible panics and unsafety.

@rust-highfive
Copy link
Contributor

r? @jackh726

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 12, 2021
@pierwill pierwill force-pushed the docs-rustc-newtype-index branch from 893874b to 399a526 Compare November 12, 2021 19:39
camelid
camelid reviewed Nov 12, 2021
View reviewed changes
camelid
camelid reviewed Nov 12, 2021
View reviewed changes
@camelid camelid added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Nov 12, 2021
@pierwill pierwill force-pushed the docs-rustc-newtype-index branch from 399a526 to 3d35e21 Compare November 12, 2021 20:26
@pierwill pierwill requested a review from camelid November 12, 2021 20:26
camelid
camelid reviewed Nov 12, 2021
View reviewed changes
Copy link
Member

@camelid camelid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let @jackh726 or someone else from T-compiler take it from here :)

jyn514
jyn514 reviewed Nov 13, 2021
View reviewed changes
jackh726
jackh726 requested changes Nov 13, 2021
View reviewed changes
Copy link
Member

@jackh726 jackh726 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

r=me with comment changed

@jackh726
Copy link
Member

@bors delegate+ rollup

Just r=jackh726 when ready

@bors
Copy link
Collaborator

bors commented Nov 13, 2021

✌️ @pierwill can now approve this pull request

@pierwill
Generate documentation in rustc rustc_index::newtype_index macro
845c25d 
The macro now documents all generated items. Documentation notes
possible panics and unsafety.
@pierwill pierwill force-pushed the docs-rustc-newtype-index branch 2 times, most recently from b6b93f9 to 845c25d Compare November 14, 2021 00:52
@pierwill
Copy link
Contributor Author

@bors r=jackh726

@bors
Copy link
Collaborator

bors commented Nov 14, 2021

📌 Commit 845c25d has been approved by jackh726

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 14, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 14, 2021
@matthiaskrgr
Rollup merge of rust-lang#90839 - pierwill:docs-rustc-newtype-index, …
3400437 
…r=jackh726

Generate documentation in rustc `rustc_index::newtype_index` macro

The macro now documents all generated items. Documentation notes possible panics and unsafety.
@matthiaskrgr matthiaskrgr mentioned this pull request Nov 14, 2021
Closed
@bors
Copy link
Collaborator

bors commented Nov 14, 2021

⌛ Testing commit 845c25d with merge 3b2c454...

@bors
Copy link
Collaborator

bors commented Nov 14, 2021

☀️ Test successful - checks-actions
Approved by: jackh726
Pushing 3b2c454 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Nov 14, 2021
@bors bors merged commit 3b2c454 into rust-lang:master Nov 14, 2021
@rustbot rustbot added this to the 1.58.0 milestone Nov 14, 2021
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (3b2c454): comparison url.

Summary: This change led to moderate relevant mixed results 🤷 in compiler performance.

  • Moderate improvement in instruction counts (up to -1.3% on incr-unchanged builds of wg-grammar)
  • Moderate regression in instruction counts (up to 1.0% on incr-unchanged builds of wg-grammar)

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

Next Steps: If you can justify the regressions found in this perf run, please indicate this with @rustbot label: +perf-regression-triaged along with sufficient written justification. If you cannot justify the regressions please open an issue or create a new PR that fixes the regressions, add a comment linking to the newly created issue or PR, and then add the perf-regression-triaged label to this PR.

@rustbot label: +perf-regression

@rustbot rustbot added the perf-regression Performance regression. label Nov 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@camelid camelid camelid left review comments

@jackh726 jackh726 jackh726 requested changes

+1 more reviewer

@jyn514 jyn514 jyn514 left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@jackh726 jackh726

Labels
merged-by-bors This PR was explicitly merged by bors. perf-regression Performance regression. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.58.0
Development

Successfully merging this pull request may close these issues.
8 participants
@pierwill @rust-highfive @jackh726 @bors @rust-timer @jyn514 @camelid @rustbot