DOC: Standardize example titles - part 2 #28641
Conversation
| Fill Between with transparency | ||
| ============================== | ||
| ================================== | ||
| ``fill_between`` with transparency |
There was a problem hiding this comment.
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.
If sphinx doesn't complain, I fully support formatting function names this way
af9f872 to
c6cf03f
Compare
galleries/examples/axes_grid1/demo_colorbar_with_inset_locator.py
Outdated
Show resolved
Hide resolved
| Filling the area between lines | ||
| ============================== | ||
| =========================== | ||
| Fill the area between lines |
There was a problem hiding this comment.
| Fill the area between lines | |
| Fill area between horizontal curves |
Mostly to draw distinction between fill_betweenx,
There was a problem hiding this comment.
I've kept the title (only adding "two"): "Fill the area between two lines"
While the docstring says "horizontal curves" and I've changed fill_betweenx to "Fill the area between vertical curves", I like the simplicity of "lines". This alludes to Line2D. 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.
galleries/examples/lines_bars_and_markers/fill_betweenx_demo.py
Outdated
Show resolved
Hide resolved
galleries/examples/misc/fig_x.py
Outdated
| Adding lines to figures | ||
| ======================= | ||
| ===================== | ||
| Add lines to a figure |
There was a problem hiding this comment.
| Add lines to a figure | |
| Draw lines without an axes |
The "no axes" part isn't implied by the title and is I think the important part.
There was a problem hiding this comment.
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.
| Embed in GTK3 with a navigation toolbar | |
| Embed plot with a navigation toolbar in GTK3 |
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.
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.
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.
Why wx #2 when it's wxagg in text?
| Embedding in wx #5 | ||
| ================== | ||
| ============== | ||
| Embed in wx #5 |
c6cf03f to
5cf1437
Compare
|
I leave all the embed stuff for now. That should be resturctured in a separate PR. |
| Fill Betweenx Demo | ||
| ================== | ||
| ========================================= | ||
| Fill the area between two vertical curves |
There was a problem hiding this comment.
| Fill the area between two vertical curves | |
| Fill the area between two vertical lines |
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.
| Add lines to directly to a figure | |
| Add lines directly to a figure |
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 to matplotlib#28544. As there: Following recommendations from matplotlib#28527, this improves example titles. Take this as an incremental improvement. I've changed what I saw t a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups. Co-authored-by: hannah <[email protected]>
5cf1437 to
a4e9e07
Compare
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.