8000 Fix removed cross-references by oscargus · Pull Request #22730 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Fix removed cross-references #22730

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 18, 2022
Merged

Fix removed cross-references #22730

merged 1 commit into from
Apr 18, 2022

Conversation

oscargus
Copy link
Member
@oscargus oscargus commented Mar 30, 2022 •
edited
Loading

PR Summary

Primarily in the old release notes, stuff that was removed over time.

Also some fixes that should lead to working cross-references in pyplot documentation.

I will continue along these lines as time allows and at some time regenerate the whole missing references-file.

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 crossreferencefixes branch from 5109c09 to d0fc7d4 Compare March 30, 2022 12:00
tacaswell
tacaswell reviewed Mar 30, 2022
View reviewed changes
doc/api/prev_api_changes/api_changes_0.91.0.rst
@@ -31,7 +31,7 @@ Changes for 0.91.0
files. In the future the class might actually parse the font to
allow e.g., subsetting.

* :mod:`matplotlib.ft2font` now supports ``FT_Attach_File``. In
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bug in the docs that we do not have an entry for matplotlib.ft2font (which to be fair also lacks a module docstring).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eh, on consideration, may we do not actually want to document this publicly....

@tacaswell tacaswell added this to the v3.6.0 milestone Mar 30, 2022
tacaswell
tacaswell approved these changes Mar 30, 2022
View reviewed changes
Copy link
Member
@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While there is a case that we should be treating these as "bug" in the docs that we have public user-facing attributes that do not have documentation, that is a much much bigger project (because if we add one, we should add them all) and we should take this chance to make the doc builds cleaner.

@tacaswell
Copy link
Member

I also think we should merge these quickly rather than building up one massive PR because PRs are free (well, very very cheap) and dealing with merge conflicts when rebasing docstrings is the worst

timhoffm
timhoffm reviewed Mar 30, 2022
View reviewed changes
@oscargus oscargus force-pushed the crossreferencefixes branch from d0fc7d4 to 7c6c5f6 Compare April 18, 2022 11:32
@oscargus
Copy link
Member Author

Updated based on @timhoffm 's suggestion. Still seems to work.

@timhoffm timhoffm merged commit 02e123a into matplotlib:main Apr 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation Maintenance
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@oscargus @tacaswell @timhoffm
0