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

Check documentation style #124

Open
timokau opened this issue May 29, 2020 · 1 comment
Open

Check documentation style #124

timokau opened this issue May 29, 2020 · 1 comment
Labels
Maintenance Documentation, tests, CI etc Priority: Low

Comments

@timokau
Copy link
Collaborator

timokau commented May 29, 2020

We have recently added some static analysis and formatting tools. One thing we are not checking for yet is inline documentation. There are some tools out there, for example pycodestyle. It seems like pylint has some doc checking functionality too.

I think it would be valuable to extend our static checks to the inline documentation. We already check stand-alone rst files with doc8..

@kiudee kiudee added Maintenance Documentation, tests, CI etc Priority: Low labels May 30, 2020
@kiudee
Copy link
Owner

kiudee commented Sep 15, 2020

Now that we have tox running a test build of the documentation, we can think about letting it fail the build, when warnings occur. We should of course fix the warnings first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Documentation, tests, CI etc Priority: Low
Projects
None yet
Development

No branches or pull requests

2 participants