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

MAINT: Update sphinxext submodule hash. #10607

Merged
merged 2 commits into from Feb 16, 2018

Conversation

Projects
None yet
1 participant
@charris
Copy link
Member

commented Feb 16, 2018

Backport of #10596.

Update to numpydoc v0.7.0, needed for sphinx 1.7.0 released 2/12/2018.

This PR also disables the doc_note function in numpy/ma/core.py. Currently, that function is called to add a "Notes" section to the existing docstrings of the unmasked versions of some functions, which may
result in duplicate "Notes" sections, or incorrect placement. Those raise errors in current numpydoc.

charris added some commits Feb 15, 2018

BUG: Functions in ma should not add Notes to existing docstrings.
Currently, the `doc_note` function in `numpy.ma.core.py` is called to
add a "Notes" section to the existing docstrings of the unmasked
versions of some functions. This may result in duplicate "Notes"
sections, or incorrect placement, which are errors in current numpydoc.
This PR disables the `doc_note` function until we can decide on the
proper way to deal with the problem.

@charris charris added this to the 1.14.1 release milestone Feb 16, 2018

@charris charris merged commit 7311b96 into numpy:maintenance/1.14.x Feb 16, 2018

4 checks passed

ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
lgtm analysis: Python 1 new alert
Details

@charris charris deleted the charris:backport-10596 branch Feb 16, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.