Skip to content

Use desc as a doc-comment for queries if there are no doc comments - #80337

Merged
bors merged 1 commit into
rust-lang:masterfrom
jyn514:add-query-desc
Dec 30, 2020
Merged

Use desc as a doc-comment for queries if there are no doc comments#80337
bors merged 1 commit into
rust-lang:masterfrom
jyn514:add-query-desc

Conversation

@jyn514

@jyn514jyn514 commented Dec 23, 2020

Copy link
Copy Markdown
Member

This at least gives some idea of what the query does even if it's not very readable. Some examples:

image
image
image

I want to turn {} into either _ or the stringified expr, but I'm not sure how to do that. In the meantime, this is better than having no docs at all.

@jyn514jyn514 added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. A-contributor-roadblock Area: Makes things more difficult for new or seasoned contributors to Rust A-query-system Area: The rustc query system (https://rustc-dev-guide.rust-lang.org/query.html) labels Dec 23, 2020
@rust-highfive

rust-highfive commented Dec 23, 2020

Copy link
Copy Markdown
Contributor

r? @varkor

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

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 23, 2020
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@camelidcamelid added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Dec 24, 2020
camelid
camelid reviewed Dec 24, 2020
View reviewed changes
Comment threadcompiler/rustc_macros/src/query.rs Outdated
danielhenrymantilla
danielhenrymantilla reviewed Dec 24, 2020
View reviewed changes
Comment threadcompiler/rustc_macros/src/query.rs Outdated
varkor
varkor reviewed Dec 26, 2020
View reviewed changes

@varkorvarkor left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It might be useful to display the output differently in these cases, to highlight that it's not a proper doc comment. Maybe in square brackets, or prefixed with "Short description:" or something like that? Is there a test we can add to ensure this continues working?

Comment threadcompiler/rustc_macros/src/query.rs Outdated
Comment threadcompiler/rustc_macros/src/query.rs Outdated
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@varkor

varkor commented Dec 30, 2020

Copy link
Copy Markdown
Contributor

Thanks! Could you squash the commits? r=me after that.

@jyn514
Use desc as a doc-comment if none exist yet
e67f9d3
- Replace {} with the stringified expr
Giant thank you to `@danielhenrymantilla` for figuring out how to make
this work ❤️
- Note that this is just an approximation and it would be better to add
a doc-comment
@jyn514

jyn514 commented Dec 30, 2020

Copy link
Copy Markdown
MemberAuthor

@bors r=varkor

@bors

bors commented Dec 30, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit e67f9d3 has been approved by varkor

@borsbors 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 Dec 30, 2020
@JohnTitorJohnTitor mentioned this pull request Dec 30, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 30, 2020
@bors
Auto merge ofrust-lang#80510- JohnTitor:rollup-gow7y0l, r=JohnTitor
507bff9
Rollup of 7 pull requests
Successful merges:
- rust-lang#80185 (Fix ICE when pointing at multi bytes character)
- rust-lang#80260 (slightly more typed interface to panic implementation)
- rust-lang#80311 (Improvements to NatVis support)
- rust-lang#80337 (Use `desc` as a doc-comment for queries if there are no doc comments)
- rust-lang#80381 (Revert "Cleanup markdown span handling")
- rust-lang#80492 (remove empty wraps, don't return Results from from infallible functions)
- rust-lang#80509 (where possible, pass slices instead of &Vec or &String (clippy::ptr_arg))
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 18ac1ec into rust-lang:masterDec 30, 2020
@rustbotrustbot added this to the 1.51.0 milestone Dec 30, 2020
@jyn514
jyn514 deleted the add-query-desc branch December 30, 2020 18:37
@jyn514jyn514 mentioned this pull request Feb 1, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@camelidcamelidcamelid left review comments
+2 more reviewers
@varkorvarkorvarkor left review comments
@danielhenrymantilladanielhenrymantilladanielhenrymantilla left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@varkorvarkor

Labels

A-contributor-roadblockArea: Makes things more difficult for new or seasoned contributors to RustA-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-query-systemArea: The rustc query system (https://rustc-dev-guide.rust-lang.org/query.html)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.51.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jyn514@rust-highfive@rust-log-analyzer@varkor@bors@danielhenrymantilla@camelid@rustbot