Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

rst markup simplification#9166

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed
anntzer wants to merge4 commits intomatplotlib:masterfromanntzer:rst-update

Conversation

anntzer
Copy link
Contributor

@anntzeranntzer commentedSep 7, 2017
edited
Loading

PR Summary

See#7502 for the original issue.

We don't actually need to use theany role yet; right now the default isalready theobj role, which resolves to any documented Python object. We can always switch the default toany (as suggested by#7502) at some later point, although I would prefersphinx-doc/sphinx#3616 be fixed before doing that.

Right now, this PR only changes .py files and not .rst files, as in the latter case we probably need to think about what to do with the old whatsnews (if we agree to make the change everywhere it can easily be added).

The PR doesn't re-line wrap the newly formatted docstrings yet as this probably needs to be done manually (and is a lot of work that can be done in subsequent PRs in a piecemeal fashion), but redoing the wrapping would probably further enhance the legibility of the docstrings.

The first commit was simply done by running

sed -i -E 's/:(mod|class|func|data|meth):`/`/g' **/*.py

The second commit fixes a few markups to make the doc build again, as explained in the commit text:

numpydoc does not like entries in See Also sections to be backquoted
without an explicit role, but it is able to handle them without
backquotes at all (in fact, that format is given in the numpydoc
specification). Fix the corresponding docstrings accordingly, and
line-wrap them.

The last commits contains piecemeal minor markup fixes.

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

This was done by running.    sed -i -E 's/:(mod|class|func|data|meth):`/`/g' **/*.pyThe current default_role setting for sphinx is `obj`, which means thatbackticks-wrapped terms automatically look up documented Python objects.
numpydoc does not like entries in See Also sections to be backquotedwithout an explicit role, but it is able to handle them withoutbackquotes at all (in fact, that format is given in the numpydocspecification).  Fix the corresponding docstrings accordingly, andline-wrap them.
@anntzeranntzerforce-pushed therst-update branch 3 times, most recently fromdcceac4 tof2658f9CompareSeptember 8, 2017 09:16
Axes.pick can be removed as it just inherits Artist.pick.
@anntzer
Copy link
ContributorAuthor

[Temporarily closing the PR as I would prefer#9173 be merged first to avoid some tricky rebase; will reopen later.]

@anntzeranntzer deleted the rst-update branchOctober 6, 2017 22:33
@anntzeranntzer self-assigned thisOct 20, 2017
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees

@anntzeranntzer

Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

1 participant
@anntzer

[8]ページ先頭

©2009-2025 Movatter.jp