-
Notifications
You must be signed in to change notification settings - Fork 1.8k
test numpydoc 1.1.0 #3045
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
test numpydoc 1.1.0 #3045
Conversation
P.S. Have you seen #3024 which is why I downgraded numpydoc to avoid v1.1.0, cross reference the numpydoc issue and PR? |
yes. I wanted to fix the issue and it appears that numpydoc v1.1.0 does not crash when the mocking for Bio.Restriction.Restriction is removed. Ie the travis builds passed. |
Oh. That's probably good, but how long does it make the autogenerated output - and is the order stable (i.e. sorted)? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3045 +/- ##
=======================================
Coverage 83.88% 83.88%
=======================================
Files 321 321
Lines 51941 51941
=======================================
Hits 43572 43572
Misses 8369 8369 ☔ View full report in Codecov by Sentry. |
I just noticed that the output is huge! it is documenting all the entries in Restriction_Dictionary and the output is not sorted. Multiple builds of the docs result in different sorting of the documented entries of the dictionary. Then maybe I will wait until your PR in numpydoc gets resolved to clean up this draft pull request. |
Yes, that was why I'd excluded the restriction docstrings - it was rather unmanageable. The other tweaks (typos and formatting) are worth applying now, but let's see what the numpydoc decide to do. |
Extracted from #3045, this fixes the doctest output rendering (was stopping at the first blank line)
Based on an RST rendering issue (due to blank lines within the doctest output) flagged on #3045 by Carlos Peña.
Originally spotted by Carlos Peña on #3045.
I didn't trace back when we moved off numpydoc 1.0.0 but we've been on numpydoc==1.7.0 for a few months now. I believe all the other minor fixes here (typos etc) have now been applied to the master branch - thank you! |
Including Carlos Peña for a few issues originally logged on #3045 [ci skip]
I hereby agree to dual licence this and any previous contributions under both
the Biopython License Agreement AND the BSD 3-Clause License.
I have read the
CONTRIBUTING.rst
file, have runflake8
locally, andunderstand that AppVeyor and TravisCI will be used to confirm the Biopython unit
tests and style checks pass with these changes.
I have added my name to the alphabetical contributors listings in the files
NEWS.rst
andCONTRIB.rst
as part of this pull request, am listedalready, or do not wish to be listed. (This acknowledgement is optional.)