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.

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

feat(docs): Check rustdoc more strictly #1185

Merged
merged 5 commits into from
Jul 7, 2023
Merged

feat(docs): Check rustdoc more strictly #1185

merged 5 commits into from
Jul 7, 2023

Conversation

flub
Copy link
Contributor

@flub flub commented Jul 7, 2023 •
edited
Loading

This makes our docs checking a bit stricter:

  • rustdoc warnings are now fatal in ci.
  • we test docs of the entire workspace...
  • we test private items as well

This includes the fixes needed to make this all work.

@flub flub marked this pull request as ready for review July 7, 2023 12:46
@flub flub enabled auto-merge (squash) July 7, 2023 13:31
@flub flub merged commit 6a58800 into main Jul 7, 2023
15 checks passed
@flub flub deleted the flub/rustdoc-private-items branch July 7, 2023 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dignifiedquire dignifiedquire dignifiedquire approved these changes

Assignees
No one assigned
Labels
None yet
Projects
iroh
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@flub @dignifiedquire