NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Add example to polygon selector docstring showing how to set vertices programmatically#22170

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

Jump to bottom

Merged

QuLogic merged 1 commit intomatplotlib:mainfromericpre:add_docstring_example_polygon_selector

Mar 15, 2022

Merged

Add example to polygon selector docstring showing how to set vertices programmatically#22170

QuLogic merged 1 commit intomatplotlib:mainfromericpre:add_docstring_example_polygon_selector

Mar 15, 2022

Conversation

Copy link

Member

ericpre commentedJan 9, 2022

PR Summary

Follow up of#21881.

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

dstansby added the topic: widgets/UI label

Jan 9, 2022

timhoffm reviewed

Jan 9, 2022

View reviewed changes

Copy link

Member

timhoffm left a comment

Choose a reason for hiding this comment

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

IMHO the main use case is still letting the user define the selection interactively. Setting vertices programmatically is only a secondary application. Therefore, it feels like the wrong priority to have this as the sole explicit example in the docstring.

I suggest to move this code to the example as well and introduce two sections for programmatically/interactive. As a bonus, the example would get a static figure contating a selection, which would be nice as the gallery thumbnail.

timhoffm added the Documentation label

Jan 9, 2022

ericpre force-pushed theadd_docstring_example_polygon_selector branch 2 times, most recently from1043571 to4c2ddf4Compare

January 11, 2022 09:04

Add a polygon selector example showing how to set vertices programmat…

08c438a

…ically and interactively

ericpre force-pushed theadd_docstring_example_polygon_selector branch from4c2ddf4 to08c438aCompare

January 11, 2022 11:36

Copy link

MemberAuthor

ericpre commentedJan 11, 2022

Link to the example:https://146-86761354-gh.circle-artifacts.com/0/doc/build/html/gallery/widgets/polygon_selector_simple.html#sphx-glr-gallery-widgets-polygon-selector-simple-py

ericpre added the status: needs review label

Jan 12, 2022

Copy link

MemberAuthor

ericpre commentedJan 13, 2022

I suggest to move this code to the example as well and introduce two sections for programmatically/interactive. As a bonus, the example would get a static figure contating a selection, which would be nice as the gallery thumbnail.

Done.