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

Appearance settings

Correct cross-references in documentation #22698

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 1 commit into from
Mar 30, 2022

Conversation

oscargus
Copy link
Member

PR Summary

Fix a few cross references in the documentation. Plus one error (cross-reference not working, but should be output_dims I assume.)

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@oscargus oscargus force-pushed the fixdoclinks branch 2 times, most recently from bc0aa77 to 4cd31dd Compare March 24, 2022 12:15
lib/matplotlib/transforms.py Show resolved Hide resolved
@tacaswell tacaswell added this to the v3.6.0 milestone Mar 24, 2022
@tacaswell
Copy link
Member

https://67441-1385122-gh.circle-artifacts.com/0/doc/build/html/api/transformations.html#matplotlib.transforms.AffineBase.transform

The output dims did not xref corretly and the sentence should be self-consistent....

@tacaswell
Copy link
Member

oh, there were three of them 🐑 Sorry I must have been looking at one you did not already change.

@QuLogic
Copy link
Member

QuLogic commented Mar 24, 2022

Are there entries for these in missing-references.json that can be removed?

@oscargus
Copy link
Member Author

Are there entries for these in missing-references.json that can be removed?

Yes, most of these (not output_dims) and some others can be removed.

I have plans to sort out more as I go along and make a proper rerun at some stage, but there are some fundamental things to sort out first (like getting inherited attributes and methods in so that they can be referenced and possibly sorting out the pyplot issues). But I can of course remove these manually for now if that is preferred.

(Also, one should maybe convert all missing references in old release notes to strings. Like:

"matplotlib.axes.Axes.dataLim": [
"doc/api/prev_api_changes/api_changes_0.99.x.rst:23"
],

Possibly the same for private classes that do not have any documentation pages. Like:

"matplotlib._mathtext.Box": [
"doc/api/mathtext_api.rst:12"
],

or
"matplotlib.patches.ArrowStyle._Curve": [
"lib/matplotlib/patches.py:docstring of matplotlib.patches.ArrowStyle.BarAB:1",
"lib/matplotlib/patches.py:docstring of matplotlib.patches.ArrowStyle.BracketA:1",
)

@QuLogic QuLogic merged commit a2a1b0a into matplotlib:main Mar 30, 2022
@QuLogic
Copy link
Member

QuLogic commented Mar 30, 2022

It's probably fine to just update them in bulk.

@oscargus oscargus deleted the fixdoclinks branch March 30, 2022 07:26
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.

4 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.