Title: rst markup simplification by anntzer · Pull Request #9166 · matplotlib/matplotlib · GitHub
Open Graph Title: rst markup simplification by anntzer · Pull Request #9166 · matplotlib/matplotlib
X Title: rst markup simplification by anntzer · Pull Request #9166 · matplotlib/matplotlib
Description: PR Summary See #7502 for the original issue. We don't actually need to use the any role yet; right now the default is already the obj role, which resolves to any documented Python object. We can always switch the default to any (as suggested by #7502) at some later point, although I would prefer sphinx-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
Open Graph Description: PR Summary See #7502 for the original issue. We don't actually need to use the any role yet; right now the default is already the obj role, which resolves to any documented Python object. We c...
X Description: PR Summary See #7502 for the original issue. We don't actually need to use the any role yet; right now the default is already the obj role, which resolves to any documented Python object. ...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/9166
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:6ada259c-760f-6c31-5baf-0b93a2bb12f1 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | A66A:152AB4:B3E847:F3352E:6A531DFD |
| html-safe-nonce | 10a2f4aeb79a57ff49f66bb65ebd0e8b5bb1d2259f3a43f35505c87b416663b4 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBNjZBOjE1MkFCNDpCM0U4NDc6RjMzNTJFOjZBNTMxREZEIiwidmlzaXRvcl9pZCI6IjMwNTQyNDAzNTM2NTU5MjIxNzMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 5942294260f9473b8dd26f895be5b527719cd066ae670851dc439d988081ccb8 |
| hovercard-subject-tag | pull_request:139870543 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/matplotlib/matplotlib/pull/9166/files |
| twitter:image | https://avatars.githubusercontent.com/u/1322974?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1322974?s=400&v=4 |
| og:image:alt | PR Summary See #7502 for the original issue. We don't actually need to use the any role yet; right now the default is already the obj role, which resolves to any documented Python object. We c... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width