Skip to content
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.

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

Make check-cfg docs more user-friendly #124209

Merged
merged 1 commit into from
May 6, 2024

Conversation

Urgau
Copy link
Member

@Urgau Urgau commented Apr 20, 2024

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

@rustbot
Copy link
Collaborator

rustbot commented Apr 20, 2024

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. F-check-cfg --check-cfg labels Apr 20, 2024
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
src/doc/rustc/src/check-cfg.md Outdated Show resolved Hide resolved
@Urgau Urgau force-pushed the check-cfg-more-friendly-docs branch from be11d8e to e7e6a56 Compare April 22, 2024 20:04
@Urgau
Copy link
Member Author

Urgau commented Apr 30, 2024

@ehuss With rust-lang/cargo#13571 progressing, I think it would be good to have these docs improvements ready by from day one.

@Urgau Urgau force-pushed the check-cfg-more-friendly-docs branch from e7e6a56 to a7a9793 Compare May 6, 2024 17:02
@ehuss
Copy link
Contributor

ehuss commented May 6, 2024

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented May 6, 2024

📌 Commit a7a9793 has been approved by ehuss

It is now in the queue for this repository.

@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 May 6, 2024
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
@bors
Copy link
Contributor

bors commented May 6, 2024

⌛ Testing commit a7a9793 with merge ce652db...

@bors
Copy link
Contributor

bors commented May 6, 2024

☀️ Test successful - checks-actions
Approved by: ehuss
Pushing ce652db to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label May 6, 2024
@bors bors merged commit ce652db into rust-lang:master May 6, 2024
7 checks passed
@rustbot rustbot added this to the 1.80.0 milestone May 6, 2024
@Urgau Urgau deleted the check-cfg-more-friendly-docs branch May 6, 2024 22:01
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (ce652db): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This 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.

Cycles

Results

This 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.

mean range count
Regressions ❌
(primary)
4.1% [4.1%, 4.1%] 1
Regressions ❌
(secondary)
- - 0
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
- - 0
All ❌✅ (primary) 4.1% [4.1%, 4.1%] 1

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 676.377s -> 676.624s (0.04%)
Artifact size: 315.98 MiB -> 315.97 MiB (-0.01%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
F-check-cfg --check-cfg merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants