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

Try to enable deny(missing_docs) and fix any ignore code blocks in docs #21

Open
6 of 7 tasks
ahayzen-kdab opened this issue Dec 9, 2021 · 2 comments
Open
6 of 7 tasks
Labels
📖 documentation Improvements or additions to documentation 🙋 good first issue Good for newcomers

Comments

@ahayzen-kdab
Copy link
Collaborator

ahayzen-kdab commented Dec 9, 2021

Try to enable #![deny(missing_docs)] in all crates and ensure any ```ignore are removed from code blocks so we have real code blocks

https://doc.rust-lang.org/rustdoc/lints.html#missing_docs

@ahayzen-kdab ahayzen-kdab added 📖 documentation Improvements or additions to documentation 🙋 good first issue Good for newcomers labels Dec 9, 2021
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Feb 28, 2023
@ahayzen-kdab ahayzen-kdab changed the title Try to enable deny(missing_docs) Try to enable deny(missing_docs) and fix any ignore code blocks in docs Feb 28, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Feb 28, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Feb 28, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Feb 28, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 1, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 2, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 2, 2023
ahayzen-kdab added a commit to ahayzen-kdab/cxx-qt that referenced this issue Mar 2, 2023
ahayzen-kdab added a commit that referenced this issue Mar 3, 2023
ahayzen-kdab added a commit that referenced this issue Mar 3, 2023
przempore pushed a commit to przempore/cxx-qt that referenced this issue Mar 15, 2023
przempore pushed a commit to przempore/cxx-qt that referenced this issue Mar 15, 2023
przempore pushed a commit to przempore/cxx-qt that referenced this issue Mar 15, 2023
@ahayzen-kdab
Copy link
Collaborator Author

cxx-qt-lib has many to fix :-)

error: could not compile `cxx-qt-lib` (lib) due to 324 previous errors

@LeonMatthesKDAB
Copy link
Collaborator

Suggestion for cxx-qt-lib:

On every type, we add a link to the corresponding Qt documentation.
Then we add #[allow(missing_docs)] on all methods that are a 1:1 wrap of a Qt API that doesn't need further comment.

Anything that is different from Qt API, we add a doc comment on.

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 🙋 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants