-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
rustdoc-json: Add test for keywords with --document-private-items
#125503
Merged
Conversation
This file contains 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
aDotInTheVoid
added
the
A-testsuite
Area: The testsuite used to check the correctness of rustc
label
May 24, 2024
rustbot
added
A-rustdoc-json
Area: Rustdoc JSON backend
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
labels
May 24, 2024
Nice! Do you think it'd be worth adding documentation about this in |
I don't think so. We already document the |
GuillaumeGomez
approved these changes
May 24, 2024
Then sounds all good to me, thanks! r=me once CI pass |
@bors r=GuillaumeGomez rollup |
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 24, 2024
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 24, 2024
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#125467 (Only suppress binop error in favor of semicolon suggestion if we're in an assignment statement) - rust-lang#125483 (compiler: validate.rs belongs next to what it validates) - rust-lang#125485 (Migrate `run-make/rustdoc-with-output-dir-option` to `rmake.rs`) - rust-lang#125497 (Fix some SIMD intrinsics documentation) - rust-lang#125501 (Resolve anon const's parent predicates to direct parent instead of opaque's parent) - rust-lang#125503 (rustdoc-json: Add test for keywords with `--document-private-items`) - rust-lang#125519 (tag more stuff with `WG-trait-system-refactor`) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 24, 2024
Rollup merge of rust-lang#125503 - aDotInTheVoid:rdj-keyword-attr, r=GuillaumeGomez rustdoc-json: Add test for keywords with `--document-private-items` Turns out this does work as-expected. I was worried that the rustdoc's clean would produce a `ItemKind::KeywordItem` for the module, and loose the module itself. But turns out we get this right. Prompted by [this discussion on zulip](https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/Where.20to.20find.20keyword.20entries.20in.20JSON.20rustdoc) r? `@GuillaumeGomez`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-rustdoc-json
Area: Rustdoc JSON backend
A-testsuite
Area: The testsuite used to check the correctness of rustc
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
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.
Turns out this does work as-expected. I was worried that the rustdoc's clean would produce a
ItemKind::KeywordItem
for the module, and loose the module itself. But turns out we get this right.Prompted by this discussion on zulip
r? @GuillaumeGomez