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

Document most items in Masonry #815

Merged
merged 6 commits into from
Jan 13, 2025
Merged

Document most items in Masonry #815

merged 6 commits into from
Jan 13, 2025

Conversation

PoignardAzur
Copy link
Contributor

@PoignardAzur PoignardAzur commented Jan 11, 2025

Move #[allow(missing_docs)] to two modules. Missing docs now warn everywhere else by default.

Remove #[expect(rustdoc::broken_intra_doc_links)] and fix all broken links.

Move `#[allow(missing_docs)]` to dow modules. Missing docs now warn everywhere else by default.
Copy link
Contributor

@jaredoconnell jaredoconnell left a comment

Choose a reason for hiding this comment

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

This is a great improvement to the documentation. I have a few minor comments.

masonry/src/action.rs Outdated Show resolved Hide resolved
masonry/src/contexts.rs Outdated Show resolved Hide resolved
masonry/src/contexts.rs Outdated Show resolved Hide resolved
masonry/src/event.rs Show resolved Hide resolved
masonry/src/event.rs Outdated Show resolved Hide resolved
@PoignardAzur
Copy link
Contributor Author

(For transparency, I'll mention I made heavier user of Copilot than usual for this PR. I don't think it's wrong, but I should probably have signaled this right away, and planned to do my own code review a day after, otherwise it starts to feel like I'm doing a high noise-to-signal contribution and expecting reviewers to filter the mistakes.)

Copy link
Contributor

@jaredoconnell jaredoconnell left a comment

Choose a reason for hiding this comment

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

This is a great improvement. I don't see any issues.

@PoignardAzur PoignardAzur added this pull request to the merge queue Jan 13, 2025
Merged via the queue into main with commit 51a3556 Jan 13, 2025
17 checks passed
@PoignardAzur PoignardAzur deleted the remove_missing_doc branch January 13, 2025 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants