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
DM-32801: Add sphinx docs build action #109
Conversation
Codecov Report
@@ Coverage Diff @@
## main #109 +/- ##
=======================================
Coverage 91.27% 91.28%
=======================================
Files 36 36
Lines 2154 2156 +2
=======================================
+ Hits 1966 1968 +2
Misses 188 188
Continue to review full report at Codecov.
|
This lets mypy find the type annotations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little worried about all of the style/lint changes going on informally without a clear roadmap or policy, but this looks OK.
Most of the fixes here are fixing legitimate problems with the numpydoc so I'm not sure what the problem is. |
pydocstyle has not been formally adopted (and barely even suggested, to my knowledge) as a tool for checking/verifying our docs. I agree that it can help us get rid of a lot of warnings and other problems, but we still shouldn't add it in random places without a clear roadmap. |
Right, but the usage here is consistent with the dev guide isn't it? What we haven't done is formalized the list of warnings that should be used -- the ones here and in daf_butler are adhoc. |
Checklist
doc/changes