Skip to content

servo: Fix rustdoc warnings#43892

Merged
simonwuelker merged 1 commit into
servo:mainfrom
simonwuelker:doc-links
Apr 3, 2026
Merged

servo: Fix rustdoc warnings#43892
simonwuelker merged 1 commit into
servo:mainfrom
simonwuelker:doc-links

Conversation

@simonwuelker
Copy link
Copy Markdown
Member

@simonwuelker simonwuelker commented Apr 3, 2026

One warning remains:

warning: public documentation for `intercept` links to private item `InterceptedWebResourceLoad`
   --> components/servo/webview_delegate.rs:240:11
    |
240 |     /// [`InterceptedWebResourceLoad`].
    |           ^^^^^^^^^^^^^^^^^^^^^^^^^^ this item is private
    |
    = note: this link resolves only because you passed `--document-private-items`, but will break without
    = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default

warning: `servo` (lib doc) generated 1 warning

I think that's a false positive, because InterceptedWebResourceLoad is public.

Testing: We don't run ./mach doc in CI, so there's no way to test this

@simonwuelker
servo: Fix rustdoc warnings
3014898 
Signed-off-by: Simon Wülker <[email protected]>
@servo-highfive servo-highfive added the S-awaiting-review There is new code that needs to be reviewed. label Apr 3, 2026
simonwuelker
simonwuelker commented Apr 3, 2026
View reviewed changes
Comment thread components/servo/webview_delegate.rs

/// Consecutive `<option>` elements outside of an `<optgroup>` will be combined
/// into a single anonymous group, whose [`label`](SelectElementGroup::label) is `None`.
/// into a single anonymous group without a label.
Copy link
Copy Markdown
Member Author

@simonwuelker simonwuelker Apr 3, 2026

Choose a reason for hiding this comment

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

The label of an <optgroup> is stored in a field of a struct enum variant, and as far as I'm aware there is no way to link to that with rustdoc.

@servo-highfive servo-highfive removed the S-awaiting-review There is new code that needs to be reviewed. label Apr 3, 2026
@simonwuelker simonwuelker added this pull request to the merge queue Apr 3, 2026
@servo-highfive servo-highfive added the S-awaiting-merge The PR is in the process of compiling and running tests on the automated CI. label Apr 3, 2026
Merged via the queue into servo:main with commit a9dd2b3 Apr 3, 2026
33 checks passed
@simonwuelker simonwuelker deleted the doc-links branch April 3, 2026 11:15
@servo-highfive servo-highfive removed the S-awaiting-merge The PR is in the process of compiling and running tests on the automated CI. label Apr 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mrobinson mrobinson mrobinson approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@simonwuelker @mrobinson @servo-highfive