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

Automate documentation validation #162

Open
eak24 opened this issue Feb 12, 2019 · 0 comments
Open

Automate documentation validation #162

eak24 opened this issue Feb 12, 2019 · 0 comments
Assignees
Labels
feature Feature request/addition low Low priority package Tasks for the core module or general package

Comments

@eak24
Copy link
Contributor

eak24 commented Feb 12, 2019

When documentation is being created (which should be done during the release build step) it is critical to validate that all the publicly exposed functions (which can be assumed to be everything that has a docstring) is fully described. At the very least, check that all the params are present in the function signature. Start by looking here: http://www.sphinx-doc.org/en/master/usage/extensions/coverage.html and see if there are any validating documentation available

@eak24 eak24 added the low Low priority label Feb 12, 2019
@oliver-leung oliver-leung changed the title automate documentation validation [FEATURE] Automate documentation validation Feb 18, 2019
@oliver-leung oliver-leung self-assigned this Feb 18, 2019
@oliver-leung oliver-leung added the feature Feature request/addition label Feb 18, 2019
@oliver-leung oliver-leung changed the title [FEATURE] Automate documentation validation Automate documentation validation Feb 19, 2019
@oliver-leung oliver-leung added the package Tasks for the core module or general package label Jul 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Feature request/addition low Low priority package Tasks for the core module or general package
Projects
None yet
Development

No branches or pull requests

3 participants