Skip to content

Correct and improve documentation for anchored artists #23864

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
Sep 11, 2022
Merged

Correct and improve documentation for anchored artists #23864

merged 1 commit into from
Sep 11, 2022

Conversation

oscargus
Copy link
Member

PR Summary

Correct doc-strings and add links in tutorial.

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).

@story645
Copy link
Member

I'm very much starting to think that the anchoredartists should be pulled out of the annotations tutorial into their own proper tutorial (can be called annotations with anchored artists or something)

story645
story645 approved these changes Sep 11, 2022
View reviewed changes
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

I think some of the constructions in the annotation tutorial are clunky, but its all language that was in before this PR so I think it's out of scope here.

@story645 story645 modified the milestones: v3.7.0, v3.6.0, unassigned, v3.6.1 Sep 11, 2022
@story645
Copy link
Member

Sorry for all the milestone changing, if I'm following the guidelines right this is a docstring change and therefore goes to next patch? https://matplotlib.org/devdocs/devel/coding_guide.html#pr-milestones

@oscargus
Copy link
Member Author

Yeah, agreed regarding the wordings. Primarily made very "local" changes to get it correct.

Not sure about the versioning either, but I agree that 3.6.1 is probably the correct version.

@story645 story645 merged commit 9f17f3f into matplotlib:main Sep 11, 2022
@oscargus
Copy link
Member Author

Although at second thought, I wonder if that applies when 3.6 is not yet released... As the v3.6.x-branch is the one it will eventually be merged to and that currently is what will become 3.6.0. So maybe change to 3.6.0 and a meekseekdev-request?

@story645
Copy link
Member

@QuLogic do I revert and remilestone?

@QuLogic QuLogic modified the milestones: v3.6.1, v3.6.0 Sep 13, 2022
@QuLogic
Copy link
Member

QuLogic commented Sep 13, 2022

3.6.1 milestone isn't backporting yet. Don't need to revert; just ask for a backport explicitly.

meeseeksdev backport to v3.6.x

@meeseeksmachine meeseeksmachine mentioned this pull request Sep 13, 2022
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 13, 2022
@story645 @meeseeksmachine
Backport PR matplotlib#23864: Correct and improve documentation for a…
2b83159 
…nchored artists
QuLogic added a commit that referenced this pull request Sep 13, 2022
@QuLogic
Merge pull request #23879 from meeseeksmachine/auto-backport-of-pr-23…
190f4dd 
…864-on-v3.6.x

Backport PR #23864 on branch v3.6.x (Correct and improve documentation for anchored artists)
@oscargus oscargus deleted the anchoredartistdocs branch September 13, 2022 07:54
melissawm pushed a commit to melissawm/matplotlib that referenced this pull request Dec 19, 2022
@story645 @melissawm
Backport PR matplotlib#23864: Correct and improve documentation for a…
c4039ba 
…nchored artists
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@story645 story645 story645 approved these changes

Assignees
No one assigned
Labels
Documentation topic: annotation topic: mpl_toolkit
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@oscargus @story645 @QuLogic