docs: require docs on all public APIs#2588
Merged
davidhewitt merged 1 commit intoPyO3:mainfrom Sep 7, 2022
Merged
Conversation
davidhewitt
force-pushed
the
require-docs
branch
3 times, most recently
from
3c2533b to
b419fb0
Compare
davidhewitt
force-pushed
the
require-docs
branch
from
b419fb0 to
ab8f940
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
#![warn(missing_docs)]to PyO3'slib.rswhich is sufficient to warn during development and block during CI (thanks to--deny=warnings.After #2587 merges there's only about 20 or so public APIs which need documentation, so I'll finish this off once that merges.
Closes #306