Skip to content

librustdoc: Make RenderOptions boolean fields into newtypes#147621

Closed
jefftt wants to merge 1 commit intorust-lang:mainfrom
jefftt:render-options-newtype
Closed

librustdoc: Make RenderOptions boolean fields into newtypes#147621
jefftt wants to merge 1 commit intorust-lang:mainfrom
jefftt:render-options-newtype

Conversation

@jefftt
Copy link

@jefftt jefftt commented Oct 12, 2025

closes #87752

@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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Oct 12, 2025
@rustbot
Copy link
Collaborator

rustbot commented Oct 12, 2025

r? @notriddle

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

@rust-log-analyzer

This comment has been minimized.

@jefftt jefftt force-pushed the render-options-newtype branch from f39b8ba to 89721a9 Compare October 12, 2025 23:30
@rust-log-analyzer
Copy link
Collaborator

The job aarch64-gnu-llvm-20-2 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot)
    |
note: associated function defined here
   --> src/librustdoc/formats/cache.rs:146:19
    |
146 |     pub(crate) fn new(document_private: DocumentPrivate, document_hidden: DocumentHidden) -> Self {
    |                   ^^^ ---------------------------------  -------------------------------
help: try wrapping the expression in `config::DocumentPrivate`
    |
 75 |     let cache = Cache::new(config::DocumentPrivate(false), false);
    |                            ++++++++++++++++++++++++     +
help: try wrapping the expression in `config::DocumentHidden`
    |
 75 |     let cache = Cache::new(false, config::DocumentHidden(false));
    |                                   +++++++++++++++++++++++     +

For more information about this error, try `rustc --explain E0308`.
[RUSTC-TIMING] rustdoc test:true 12.456
error: could not compile `rustdoc` (lib test) due to 1 previous error

pub(crate) generate_macro_expansion: bool,
pub(crate) generate_macro_expansion: GenerateMacroExpansion,
}

Copy link
Member

@fmease fmease Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please turn all of them into enum { Yes, No }, that's what's more conventional in this repo (and also what Esteban suggested back then (see the PR linked from the issue)).

@notriddle
Copy link
Contributor

r? @fmease

@rustbot rustbot assigned fmease and unassigned notriddle Oct 13, 2025
@rustbot
Copy link
Collaborator

rustbot commented Oct 13, 2025

fmease is currently at their maximum review capacity.
They may take a while to respond.

@fmease
Copy link
Member

fmease commented Oct 13, 2025

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 13, 2025
@rustbot
Copy link
Collaborator

rustbot commented Oct 13, 2025

Reminder, once the PR becomes ready for a review, use @rustbot ready.

@bors
Copy link
Collaborator

bors commented Oct 30, 2025

☔ The latest upstream changes (presumably #148280) made this pull request unmergeable. Please resolve the merge conflicts.

@SpriteOvO
Copy link
Member

@jefftt Hi, ping from triage team. There is a review comment needs to be resolved, would you like to take a look at it? Thanks

@GuillaumeGomez
Copy link
Member

Closing as we decided to not go through with it.

@rustbot rustbot removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Feb 26, 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 T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make RenderOptions fields' type into newtype instead of boolean for clarity

8 participants