Make check-cfg docs more user-friendly #124209
Merged
Conversation
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
Collaborator
rustbot
added
S-waiting-on-review
Noratrieb
reviewed
Apr 21, 2024
Urgau
force-pushed
the
check-cfg-more-friendly-docs
branch
from
79cf715 to
be11d8e
Compare
ehuss
reviewed
Apr 22, 2024
Urgau
force-pushed
the
check-cfg-more-friendly-docs
branch
from
be11d8e to
e7e6a56
Compare
Member
Author
|
@ehuss With rust-lang/cargo#13571 progressing, I think it would be good to have these docs improvements ready by from day one. |
Urgau
force-pushed
the
check-cfg-more-friendly-docs
branch
from
e7e6a56 to
a7a9793
Compare
Contributor
|
Thanks! @bors r+ rollup |
Collaborator
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
May 6, 2024
…, r=ehuss Make check-cfg docs more user-friendly This PR improves the `--check-cfg` to make them more user-friendly by: - explaining the purpose of the feature - removing the "form" jargon - making it (bit) less formal and more "friendly" - making the doc less cluttered - and by fixing (the width and flags) of the examples `@rustbot` label +F-check-cfg
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 6, 2024
…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#124209 (Make check-cfg docs more user-friendly) - rust-lang#124759 (Record impl args in the proof tree in new solver) - rust-lang#124809 (borrowck: prepopulate opaque storage more eagerly) - rust-lang#124815 (Update books) r? `@ghost` `@rustbot` modify labels: rollup
Collaborator
Collaborator
|
☀️ Test successful - checks-actions |
Collaborator
|
Finished benchmarking commit (ce652db): comparison URL. Overall result: no relevant changes - no action needed@rustbot label: -perf-regression Instruction countThis benchmark run did not return any relevant results for this metric. Max RSS (memory usage)This benchmark run did not return any relevant results for this metric. CyclesResultsThis is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.
Binary sizeThis benchmark run did not return any relevant results for this metric. Bootstrap: 676.377s -> 676.624s (0.04%) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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 PR improves the
--check-cfgto make them more user-friendly by:@rustbot label +F-check-cfg