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

Supplied docs/conf.py fails prospector #26

Closed
LourensVeen opened this issue Sep 4, 2018 · 2 comments
Closed

Supplied docs/conf.py fails prospector #26

LourensVeen opened this issue Sep 4, 2018 · 2 comments

Comments

@LourensVeen
Copy link
Member

The supplied docs/conf.py gives a whole bunch of errors if you run prospector. Having it ignore the docs/ directory is probably a good idea.

@LourensVeen
Copy link
Member Author

On further playing with it, it turns out that prospector also gives a thumbs-down to my valid Google-style docstrings, insists that I put a docstring in an otherwise empty init.py, and is annoying me to no end. I'm sure I could tweak the configuration, but I'd rather just get rid of the whole sorry thing...

jvdzwaan pushed a commit that referenced this issue Sep 5, 2018
So it doesn't complain about conf.py

Refs #26
@jvdzwaan
Copy link

jvdzwaan commented Sep 5, 2018

I agree that prospector is too strict. I will update the configuration to strictness medium and no doc warnings.

On the other hand, it may be good to keep in mind that prospector is a tool, and that sometimes the human knows better. It is okay to have some (but not too many) warnings and just live with them. That is why checking the code style is not automated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants