Use desc as a doc-comment for queries if there are no doc comments#80337
Merged
bors merged 1 commit intorust-lang:masterfrom Dec 30, 2020
Merged
Use desc as a doc-comment for queries if there are no doc comments#80337bors merged 1 commit intorust-lang:masterfrom
desc as a doc-comment for queries if there are no doc comments#80337bors merged 1 commit intorust-lang:masterfrom
Conversation
jyn514
added
T-compiler
Contributor
|
r? @varkor (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
jyn514
force-pushed
the
add-query-desc
branch
from
63a400f to
10199c2
Compare
camelid
added
the
A-docs
camelid
reviewed
Dec 24, 2020
varkor
reviewed
Dec 26, 2020
Contributor
varkor
left a comment
varkor
left a comment
There was a problem hiding this comment.
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?
This comment has been minimized.
This comment has been minimized.
jyn514
force-pushed
the
add-query-desc
branch
from
93af72f to
9d9cd44
Compare
Contributor
|
Thanks! Could you squash the commits? r=me after that. |
- 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
force-pushed
the
add-query-desc
branch
from
9d9cd44 to
e67f9d3
Compare
Member
Author
|
@bors r=varkor |
Collaborator
|
📌 Commit e67f9d3 has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 30, 2020
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This at least gives some idea of what the query does even if it's not very readable. Some examples:
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.