Skip to content
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

Fix / remove warnings in Masonry documentation #449

Closed
waywardmonkeys opened this issue Jul 25, 2024 · 6 comments
Closed

Fix / remove warnings in Masonry documentation #449

waywardmonkeys opened this issue Jul 25, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation masonry Issues relating to the Masonry widget layer

Comments

@waywardmonkeys
Copy link
Contributor

Separate from #389, the warnings when running cargo doc -p masonry need to be fixed.

Most of them are about things that no longer exist within masonry or have perhaps changed names, so it should be a pretty quick pass.

This is blocking re-enabling denying warnings within CI for xilem documentation and has already led to an issue in that regard with a broken link making its way into there.

@waywardmonkeys waywardmonkeys added documentation Improvements or additions to documentation masonry Issues relating to the Masonry widget layer labels Jul 25, 2024
@waywardmonkeys
Copy link
Contributor Author

This is even worse with cargo clippy -- -W clippy::doc_markdown and that has even more regressions in xilem_core, xilem_web, and xilem.

waywardmonkeys added a commit to waywardmonkeys/xilem that referenced this issue Aug 2, 2024
waywardmonkeys added a commit to waywardmonkeys/xilem that referenced this issue Aug 2, 2024
github-merge-queue bot pushed a commit that referenced this issue Aug 2, 2024
waywardmonkeys added a commit to waywardmonkeys/xilem that referenced this issue Aug 25, 2024
waywardmonkeys added a commit to waywardmonkeys/xilem that referenced this issue Aug 25, 2024
github-merge-queue bot pushed a commit that referenced this issue Aug 25, 2024
@PoignardAzur
Copy link
Contributor

This should be fixed by #815. Are there still errors?

@DJMcNab
Copy link
Member

DJMcNab commented Jan 29, 2025

This issue also tracks re-enabling checking for these issues in CI. Is that resolved?

@PoignardAzur PoignardAzur reopened this Jan 30, 2025
@PoignardAzur
Copy link
Contributor

PoignardAzur commented Jan 30, 2025

Well I didn't change the CI scripts after fixing the doc errors, so probably not.

@DJMcNab
Copy link
Member

DJMcNab commented Jan 30, 2025

It looks like https://github.com/linebender/xilem/pull/815/files#diff-27b19fb95b25f32e39ea044b6ab68ee4a84d37944078b20ea52985fcca779e7aL112-L115 should have addressed this, I think.

The only thing that's still wrong is

#![warn(rustdoc::broken_intra_doc_links, clippy::doc_markdown, missing_docs)]

which is redundant I think. It looks like these were being suppressed by allows rather than anything in the CI script.

waywardmonkeys added a commit to waywardmonkeys/xilem that referenced this issue Jan 30, 2025
These are no longer suppressed above it in the crate, so this
isn't needed now.

Related to linebender#449.
@waywardmonkeys
Copy link
Contributor Author

@DJMcNab I'd removed that locally yesterday but didn't get to submitting the PR. Done now as #855.

github-merge-queue bot pushed a commit that referenced this issue Jan 30, 2025
These are no longer suppressed above it in the crate, so this isn't
needed now.

Related to #449.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation masonry Issues relating to the Masonry widget layer
Projects
None yet
Development

No branches or pull requests

3 participants