Skip to content

rustdoc-json: fix incorrect documentation for VariantKind::Struct#153573

Merged
rust-bors[bot] merged 1 commit intorust-lang:mainfrom
yshui-forks:rustdoc-types-doc
Mar 9, 2026
Merged

rustdoc-json: fix incorrect documentation for VariantKind::Struct#153573
rust-bors[bot] merged 1 commit intorust-lang:mainfrom
yshui-forks:rustdoc-types-doc

Conversation

@yshui
Copy link
Contributor

@yshui yshui commented Mar 8, 2026

Seems to have been copy-and-pasted from Enum::variants, but VariantKind::Struct::fields is for struct variant fields, not enum variants.

@rustbot
Copy link
Collaborator

rustbot commented Mar 8, 2026

rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing src/librustdoc/json/conversions.rs; otherwise, make sure you bump the FORMAT_VERSION constant.

cc @CraftSpider, @aDotInTheVoid, @Enselic, @obi1kenobi

@rustbot 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 Mar 8, 2026
@rustbot
Copy link
Collaborator

rustbot commented Mar 8, 2026

r? @GuillaumeGomez

rustbot has assigned @GuillaumeGomez.
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

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: rustdoc
  • rustdoc expanded to 9 candidates
  • Random selection from GuillaumeGomez, camelid, fmease, lolbinarycat, notriddle

@GuillaumeGomez
Copy link
Member

@bors r=obi1kenobi,GuillaumeGomez rollup

@rust-bors
Copy link
Contributor

rust-bors bot commented Mar 8, 2026

📌 Commit 43e3fd1 has been approved by obi1kenobi,GuillaumeGomez

It is now in the queue for this repository.

@rust-bors rust-bors bot 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 Mar 8, 2026
rust-bors bot pushed a commit that referenced this pull request Mar 9, 2026
…uwer

Rollup of 6 pull requests

Successful merges:

 - #152535 (std: use `OnceLock` for Xous environment variables)
 - #152646 (Update `UnsafeUnpin` impls involving extern types.)
 - #153559 (Inline and simplify some code for saving incremental data to disk)
 - #151900 (num: Separate public API from internal implementations)
 - #153520 (.mailmap: fix broken line with multiple emails)
 - #153573 (rustdoc-json: fix incorrect documentation for VariantKind::Struct)

Failed merges:

 - #153509 (Cleanup unused diagnostic emission methods - part 2)
@rust-bors rust-bors bot merged commit 934afe3 into rust-lang:main Mar 9, 2026
11 checks passed
rust-timer added a commit that referenced this pull request Mar 9, 2026
Rollup merge of #153573 - yshui-forks:rustdoc-types-doc, r=obi1kenobi,GuillaumeGomez

rustdoc-json: fix incorrect documentation for VariantKind::Struct

Seems to have been copy-and-pasted from `Enum::variants`, but `VariantKind::Struct::fields` is for struct variant fields, not enum variants.
@rustbot rustbot added this to the 1.96.0 milestone Mar 9, 2026
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 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants