Skip to content

Documentation: Fix cross reference links and warnings - #4718

Open
ogoffart wants to merge 1 commit into
rust-windowing:masterfrom
slint-ui:olivier/docs
Open

ogoffart wants to merge 1 commit into
rust-windowing:masterfrom
slint-ui:olivier/docs

Conversation

@ogoffart

Copy link
Copy Markdown
Contributor

The CI only checked docs warnings on the winit crate which is the only default emember of the workspace. Added the --worksace flag to check documentation on all the member.

Adding a #[cfg(doc)] use ... only work within a single crate (eg winit-core), but when re-exported items are documented in the winit crate itself, it doesn't work.

Removing link to ActiveEventLoop::request_activation_token that no longer exist.

Fiw the winit-web docs that were still trying to reference things in crate:: instead of winit_core::

The CI only checked docs warnings on the `winit` crate which is the only
default emember of the workspace. Added the `--worksace` flag to check
documentation on all the member.

Adding a `#[cfg(doc)] use ...` only work within a single crate (eg
winit-core), but when re-exported items are documented in the winit
crate itself, it doesn't work.

Removing link to `ActiveEventLoop::request_activation_token` that no
longer exist.

Fiw the winit-web docs that were still trying to reference things in
`crate::` instead of `winit_core::`

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant