Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: Standardize example titles - part 2#28641
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
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| Fill Between with transparency | ||
| ============================== | ||
| ================================== | ||
| ``fill_between`` with transparency |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
So far, there's only one case of formatting example titles (plt.subplots). I feel it's slightly better to format function names as literal rather than just have them as plain text. But no strong opinion. We can also leave out the formatting if desired.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
If sphinx doesn't complain, I fully support formatting function names this way
af9f872 toc6cf03fCompareThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks for putting in easy to review on phone PRs 😅
galleries/examples/axes_grid1/demo_colorbar_with_inset_locator.py OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
| Filling the area between lines | ||
| ============================== | ||
| =========================== | ||
| Fill the area between lines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Filltheareabetweenlines | |
| Fillareabetweenhorizontalcurves |
Mostly to draw distinction between fill_betweenx,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I've kept the title (only adding "two"): "Fill the area between two lines"
While the docstring says "horizontal curves" and I've changedfill_betweenx to "Fill the area between vertical curves", I like the simplicity of "lines". This alludes toLine2D. The term "horizontal curve" insinuates precision, but is acutally still vague.
What "horizontal curve" actually means, are two curves that are defined at the same horizontal positions x. Visually, the lines can be quite non-horizontal. But I'm unable to express this in the title, so I stick to the very generic description, which I believe will catch people intuitively.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
galleries/examples/misc/fig_x.py Outdated
| Adding lines to figures | ||
| ======================= | ||
| ===================== | ||
| Add lines to a figure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Addlinestoafigure | |
| Drawlineswithoutanaxes |
The "no axes" part isn't implied by the title and is I think the important part.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The point is really "to a figure" not "without an axes".
Getting a bit out of scope, but small enough to not make a separate PR: I've changed the content of the example to something more practical:
| Embedding in GTK3 with a navigation toolbar | ||
| =========================================== | ||
| ======================================= | ||
| Embed in GTK3 with a navigation toolbar |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| EmbedinGTK3withanavigationtoolbar | |
| EmbedplotwithanavigationtoolbarinGTK3 |
I think here it might be better to have the subject
| Embedding in GTK4 with a navigation toolbar | ||
| =========================================== | ||
| ======================================= | ||
| Embed in GTK4 with a navigation toolbar |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Same as 3, also do we want this as one example (embed in GTK) and then maybe tab GTK3 and GTK4 or have them as subheadings?
| Embedding in GTK4 | ||
| ================= | ||
| ============= | ||
| Embed in GTK4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Same, do we want one GTK example and then the diff versions as subheadings?
| Embedding in wx #2 | ||
| ================== | ||
| ============== | ||
| Embed in wx #2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Why wx#2 when it's wxagg in text?
| Embedding in wx #5 | ||
| ================== | ||
| ============== | ||
| Embed in wx #5 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Can all the wx be combined?
I leave all the embed stuff for now. That should be resturctured in a separate PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
slight grammar consistency nits, can self merge after fixing those.
| Fill Betweenx Demo | ||
| ================== | ||
| ========================================= | ||
| Fill the area between two vertical curves |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Filltheareabetweentwoverticalcurves | |
| Filltheareabetweentwoverticallines |
since you like lines better, since the terminology should stay consistent across both. I'm not sure if I think this example should be combined w/ the other one.
galleries/examples/misc/fig_x.py Outdated
| Adding lines to figures | ||
| ======================= | ||
| ================================= | ||
| Add lines to directly to a figure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Addlinestodirectlytoafigure | |
| Addlinesdirectlytoafigure |
grammar nit,
and my qualm/concern is folks not understanding what "to a figure" means, but the more I unpack that the more I'm thinking it probably can't be solved in a title
Follow up tomatplotlib#28544. As there:Following recommendations frommatplotlib#28527, this improves example titles.Take this as an incremental improvement. I've changed what I saw t aglance when going through the examples once. Certainly, one could dofurther improvements, but that can be done in follow-ups.Co-authored-by: hannah <story645@gmail.com>
c17197c intomatplotlib:mainUh oh!
There was an error while loading.Please reload this page.
Follow up to#28544. As there:
Following recommendations from#28527, this improves example titles. Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.