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

DOC: Add descriptions to matplotlib.typing#29918

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

Merged
timhoffm merged 1 commit intomatplotlib:mainfromtimhoffm:doc-typing
May 1, 2025

Conversation

timhoffm
Copy link
Member

PR summary

PR checklist

@github-actionsgithub-actionsbot added the Documentation: APIfiles in lib/ and doc/api labelApr 15, 2025
@timhoffm
Copy link
MemberAuthor

Comment on lines 15 to +17
.. autodata:: matplotlib.typing.ColourType
.. autodata:: matplotlib.typing.RGBColourType
.. autodata:: matplotlib.typing.RGBAColourType
Copy link
Member

Choose a reason for hiding this comment

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

These seem to need docstrings, even if they are just "Alias of ...", because right now they are the rather unclear "Represent a PEP 604 union type".

Also, any idea why these colour types seem to get the type alias in bold next to the name, whereas the style ones seem to get "alias of ..." in the description instead?

Copy link
MemberAuthor

@timhoffmtimhoffmApr 16, 2025
edited
Loading

Choose a reason for hiding this comment

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

I've noted this as well, but decided to not bother right now. I don't want to spend time on it, and it's not getting worse through the PR.

There must be some issue in autodoc. If that gets fixed, we should get the right description automatically.

More fundamentally, why do we need these aliases? All our function/parameter names use "color" and we don't alias them. I'm tempted to remove the aliases here (only leaving them for now because as said, I don't want to spend much time on this)

Copy link
Member

Choose a reason for hiding this comment

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

If I had my way, I'd have the colour spelling available everywhere, but I don't remember why these specifically are here.

Copy link
MemberAuthor

@timhoffmtimhoffmMay 1, 2025
edited
Loading

Choose a reason for hiding this comment

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

I've add docstrings to the aliases for now. Though, I'd propose to remove the aliases because AFAIK we don't have aliases anywhere else in the API. But that's a separeate discussion.

@timhoffmtimhoffm added this to thev3.10.2 milestoneMay 1, 2025
@timhoffmtimhoffm merged commit6378dd0 intomatplotlib:mainMay 1, 2025
35 of 36 checks passed
@timhoffmtimhoffm deleted the doc-typing branchMay 1, 2025 08:41
@lumberbot-appLumberbot (App)
Copy link

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.10.xgit pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 6378dd0277f2900eb9ad5843b674f7fbe77719bf
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #29918: DOC: Add descriptions to matplotlib.typing'
  1. Push to a named branch:
git push YOURFORK v3.10.x:auto-backport-of-pr-29918-on-v3.10.x
  1. Create a PR against branch v3.10.x, I would have named this PR:

"Backport PR#29918 on branch v3.10.x (DOC: Add descriptions to matplotlib.typing)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove theStill Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free tosuggest an improvement.

@timhoffm
Copy link
MemberAuthor

Not worth a manual backport.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic left review comments

@ksundenksundenksunden approved these changes

Assignees
No one assigned
Labels
Documentation: APIfiles in lib/ and doc/api
Projects
None yet
Milestone
v3.11.0
Development

Successfully merging this pull request may close these issues.

3 participants
@timhoffm@QuLogic@ksunden

[8]ページ先頭

©2009-2025 Movatter.jp