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: plotting section for Users Guide#29124
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
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _contour_demo: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Is there a reason you introduce labels to a lot of examples? Generally, we've been referencing examples via the doc There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Because if we have to re-arrange things all these hard links break, whereas labeled references do not break. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. IMHO this is a case of YAGNI. We are quite conservative on the structure because it translates to public URLs. And if we really want to change, that’s a quite easy search&replace, which we need to anyway, because our current way of referencing examples is predominantly doc based. This makes the PR look more complicated and I’ve some reservations whether it’s actually better to reference examples using labels. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I don't mind it b/c we've done some thrashing on the galleries, but I think it might make both discussions easier if it was spun out into a separate PR There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more.
This was a huge barrier to making doc changes 5 or so years ago. Since then we introduced the redirect mechanism which has allowed things to be moved. It is likely true that our predominant way of referencing things is Regardless, I don't think this really affects this PR. I made zero substantive changes to any of the other files - I just added the reference label. I also didn't change any Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more.
To give a number: 7 examples have labels. but we have 150 :doc: references.
I beg to differ:
So the effect is at least I'm not looking at this, which is fine as long as you find other reviewers. I'm just giving my perspective. Others would have to comment on why they haven't reviewed. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more.
Again, this isn't new, or just being introduced now - we have had label-based referencing for as long as I have been contributing. All this PR does is add labels, it doesn't change any existing references. If I put in a stand-alone PR with just the labels, that is all it would be - a bunch of labels not used anywhere yet. I can certainly do that if you like, but I'm not sure what the point is.
An aside, for sure, but Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @jklymak do you have a strong objection to splitting off the labeling PR from the plotting guide PR? I tend to review docs on my phone so it's a lot to scroll past, and as the back and forth with Tim is showing there's a whole separate conversation to be had about labeling.
That's fine, folks do staged PRs all the time. Just say it's for this PR. Or put adding the labels in a separate first commit so reviewers can filter it out. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I could do both those things if it makes things easier. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Done | ||
============ | ||
Contour Demo | ||
============ | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
""" | ||
.. _contourf_demo: | ||
============= | ||
Contourf demo | ||
============= | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _contourf_log: | ||
============================ | ||
Contourf and log color scale | ||
============================ | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,8 @@ | ||
""" | ||
.. _image_antialiasing: | ||
.. _image_resampling: | ||
================ | ||
Image resampling | ||
================ | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _image_demo: | ||
======================== | ||
Many ways to plot images | ||
======================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _pcolor_demo: | ||
============= | ||
pcolor images | ||
============= | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _pcolormesh_grids: | ||
============================ | ||
pcolormesh grids and shading | ||
============================ | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _plot_streamplot: | ||
========== | ||
Streamplot | ||
========== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _tricontour_demo: | ||
=============== | ||
Tricontour Demo | ||
=============== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _tricontour_smooth_delaunay: | ||
========================== | ||
Tricontour Smooth Delaunay | ||
========================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _tricontour_smooth_user: | ||
====================== | ||
Tricontour Smooth User | ||
====================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _tripcolor_demo: | ||
============== | ||
Tripcolor Demo | ||
============== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _triplot_demo: | ||
============ | ||
Triplot Demo | ||
============ | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _eventplot_demo: | ||
============== | ||
Eventplot demo | ||
============== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _step_demo: | ||
========= | ||
Step Demo | ||
========= | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _box3d: | ||
=================== | ||
3D box surface plot | ||
=================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _intersecting_planes: | ||
=================== | ||
Intersecting planes | ||
=================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _quiver3d: | ||
============== | ||
3D quiver plot | ||
============== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _stem3d_demo: | ||
======= | ||
3D stem | ||
======= | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _surface3d: | ||
===================== | ||
3D surface (colormap) | ||
===================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _surface3d_2: | ||
======================== | ||
3D surface (solid color) | ||
======================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _surface3d_3: | ||
========================= | ||
3D surface (checkerboard) | ||
========================= | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _trisurf3d: | ||
====================== | ||
Triangular 3D surfaces | ||
====================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _trisurf3d_2: | ||
=========================== | ||
More triangular 3D surfaces | ||
=========================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _boxplot_demo: | ||
======== | ||
Boxplots | ||
======== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _customized_violin: | ||
========================= | ||
Violin plot customization | ||
========================= | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _hexbin_demo: | ||
===================== | ||
Hexagonal binned plot | ||
===================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _violinplot: | ||
================== | ||
Violin plot basics | ||
================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _bar3d_simple: | ||
========================== | ||
bar3d(x, y, z, dx, dy, dz) | ||
========================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _surface3d_simple: | ||
===================== | ||
plot_surface(X, Y, Z) | ||
===================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
""" | ||
.. _trisurf3d_simple: | ||
===================== | ||
plot_trisurf(x, y, z) | ||
===================== | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _users-guide-artists: | ||
+++++++ | ||
Artists | ||
+++++++ | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _users_guide_axes: | ||
+++++++++++++++++ | ||
Axes and subplots | ||
+++++++++++++++++ | ||
Uh oh!
There was an error while loading.Please reload this page.