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

FIX: Return value instead of enum in get_capstyle/_joinstyle#22055

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

Conversation

StefRe
Copy link
Contributor

PR Summary

There's an API inconsistency in the return values ofget_capstyle /get_joinstyle: ForLine2D,Collections andGraphicsContextBase they return a string whereas forMarkerStyle andPatch they return an enum object, see also#21979 (comment).

_enums was introduced in#18544 in mpl 3.4.0 without being mentioned in therelease notes. Itsdocumentation states:

The classes in this module are used internally and serve to document these concepts formally.

From this I conclude that the enum should not leak out to the user, i.e.get_capstyle /get_joinstyle should return as string forMarkerStyle andPatch too. As the change from string to enum as not mentioned in the release note I guess changing it back is not an API change but a bug fix and it doesn't need not be documented (see Checklist below).

PR Checklist

Tests and Styling

  • [N/A ] Has pytest style unit tests (andpytest passes).
  • IsFlake 8 compliant (installflake8-docstrings and runflake8 --docstring-convention=all).

Documentation

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

for MarkerStyle and Patch (as do Line2D, Collections and GraphicsContextBase)
@StefRe
Copy link
ContributorAuthor

@dstansby
Copy link
Member

It looks like at least some errors were package download related. I've restarted the tests to see if another run works.

@QuLogicQuLogic merged commit7388222 intomatplotlib:mainJan 14, 2022
@QuLogicQuLogic added this to thev3.6.0 milestoneJan 14, 2022
@StefReStefRe deleted the fix/get_cap_join_style_return_value branchJanuary 14, 2022 07:11
QuLogic added a commit to QuLogic/matplotlib that referenced this pull requestMay 6, 2023
When these Enum classes were added inmatplotlib#18544, they were supposed to befor documentation only. To that end,matplotlib#22055 was a followup that ensuredthat only the strings were exposed from the getter side.However, when user-supplied cap/join style were added inmatplotlib#20914, theywere only for the Enum type instead of the string, so correctly allowstrings here as well.Also, specifically type hint the return values as literals, as was doneinmatplotlib#25719.
QuLogic added a commit to QuLogic/matplotlib that referenced this pull requestMay 6, 2023
When these Enum classes were added inmatplotlib#18544, they were supposed to befor documentation only. To that end,matplotlib#22055 was a followup that ensuredthat only the strings were exposed from the getter side.However, when user-supplied cap/join style were added inmatplotlib#20914, theywere only for the Enum type instead of the string, so correctly allowstrings here as well.Also, specifically type hint the return values as literals, as was doneinmatplotlib#25719.
@QuLogicQuLogic mentioned this pull requestMay 6, 2023
1 task
QuLogic added a commit to QuLogic/matplotlib that referenced this pull requestMay 31, 2023
When these Enum classes were added inmatplotlib#18544, they were supposed to befor documentation only. To that end,matplotlib#22055 was a followup that ensuredthat only the strings were exposed from the getter side.However, when user-supplied cap/join style were added inmatplotlib#20914, theywere only for the Enum type instead of the string, so correctly allowstrings here as well.Also, specifically type hint the return values as literals, as was doneinmatplotlib#25719.
devRD pushed a commit to devRD/matplotlib that referenced this pull requestJun 5, 2023
When these Enum classes were added inmatplotlib#18544, they were supposed to befor documentation only. To that end,matplotlib#22055 was a followup that ensuredthat only the strings were exposed from the getter side.However, when user-supplied cap/join style were added inmatplotlib#20914, theywere only for the Enum type instead of the string, so correctly allowstrings here as well.Also, specifically type hint the return values as literals, as was doneinmatplotlib#25719.
melissawm pushed a commit to melissawm/matplotlib that referenced this pull requestJun 15, 2023
When these Enum classes were added inmatplotlib#18544, they were supposed to befor documentation only. To that end,matplotlib#22055 was a followup that ensuredthat only the strings were exposed from the getter side.However, when user-supplied cap/join style were added inmatplotlib#20914, theywere only for the Enum type instead of the string, so correctly allowstrings here as well.Also, specifically type hint the return values as literals, as was doneinmatplotlib#25719.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic approved these changes

@anntzeranntzeranntzer approved these changes

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

Successfully merging this pull request may close these issues.

4 participants
@StefRe@dstansby@QuLogic@anntzer
[8]ページ先頭
©2009-2025 Movatter.jp