Skip to content

cxx-qt: activate doctests for the macros and deny missing docs in the crate #456

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Mar 3, 2023
Merged

cxx-qt: activate doctests for the macros and deny missing docs in the crate #456

merged 3 commits into from
Mar 3, 2023

Conversation

ahayzen-kdab
Copy link
Collaborator

Related to #21

@ahayzen-kdab
Copy link
Collaborator Author

Figured out how to get the doctests going on the macro page, we just needed a fake main and then the dependencies.

@ahayzen-kdab ahayzen-kdab mentioned this pull request Feb 28, 2023
Open
7 tasks
@ahayzen-kdab ahayzen-kdab force-pushed the 21-cxx-qt-macro-doctests branch 2 times, most recently from 2463ac0 to 0156af5 Compare March 1, 2023 11:00
@ahayzen-kdab ahayzen-kdab marked this pull request as draft March 1, 2023 12:03
@ahayzen-kdab ahayzen-kdab force-pushed the 21-cxx-qt-macro-doctests branch 2 times, most recently from 28a1830 to 48eb232 Compare March 1, 2023 15:17
@ahayzen-kdab ahayzen-kdab marked this pull request as ready for review March 1, 2023 16:06
@ahayzen-kdab ahayzen-kdab mentioned this pull request Mar 1, 2023
Closed
@ahayzen-kdab ahayzen-kdab force-pushed the 21-cxx-qt-macro-doctests branch from 48eb232 to fa26bde Compare March 2, 2023 15:09
LeonMatthesKDAB
LeonMatthesKDAB approved these changes Mar 3, 2023
View reviewed changes
Copy link
Collaborator

@LeonMatthesKDAB LeonMatthesKDAB left a comment

Choose a reason for hiding this comment

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

Overall, great change!

We shouldn't close #21 yet though, as #![deny(missing_docs)] isn't enabled on cxx-qt-lib, where it is arguably most important.
There's currently 259 items in cxx-qt-lib that aren't documented, so we should fix that before closing #21.

@ahayzen-kdab ahayzen-kdab merged commit 752305b into KDAB:main Mar 3, 2023
@ahayzen-kdab
Copy link
Collaborator Author

Yup there is still -gen, -lib, and qt-build-utils to deny missing docs on, they needed more changes.

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

@LeonMatthesKDAB LeonMatthesKDAB LeonMatthesKDAB 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.
2 participants
@ahayzen-kdab @LeonMatthesKDAB