Skip to content

DOC: fix erroneous numpydoc_edit_link formatting #309

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

Merged
merged 4 commits into from
Jan 21, 2021
Merged

DOC: fix erroneous numpydoc_edit_link formatting #309

merged 4 commits into from
Jan 21, 2021

Conversation

sappelhoff
Copy link
Contributor

This is mainly a fix for a missing linebreak in the documentation about numpydoc_edit_link which leads to a wrong rendering:

image

see: https://numpydoc.readthedocs.io/en/latest/install.html#sphinx-config-options

I couldn't find which version numpydoc_edit_link was deprecated, so if someone knows, it'd be good to add the version after the directive.

Then I also corrected an indent for consistency, this should have no impact on the actual rendering

@sappelhoff
Copy link
Contributor Author

sappelhoff commented Jan 21, 2021

Tests are failing because the argument to the .. deprecated:: directive seems to be REQUIRED. Prior to this PR, the first word of the next sentence was parsed as the argument to the directive (erroneously).

git log -S numpydoc_edit_link did not help me to figure out in which version this was deprecated 🤔 I'll try to find it via git blame

EDIT: I was unsuccessful in finding a commit or similar of when the deprecation took place. But given that #122 occurred on 2017-10-23, I looked at the release history and it's very likely that the deprecation happend in 0.7.0 (from 2017-06-20) or earlier, so I put 0.7.0 for now.

@larsoner larsoner merged commit da816b5 into numpy:master Jan 21, 2021
@larsoner
Copy link
Collaborator

Straightforward improvement, thanks @sappelhoff !

@sappelhoff sappelhoff deleted the fix1 branch January 21, 2021 21:06
@jarrodmillman jarrodmillman added this to the 1.2.0 milestone Jan 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants