Add one-line descriptions to 19 examples currently missing them #8887
Conversation
examples/pylab_examples/axes_demo.py
Outdated
| @@ -3,6 +3,7 @@ | |||
| Axes Demo | |||
| ========= | |||
|
|
|||
| Example use of `plt.axes` to create inset axes within the main plot axes. | |||
There was a problem hiding this comment.
use `` rather than ` when showing code style in rST
| @@ -3,6 +3,7 @@ | |||
| Axhspan Demo | |||
| ============ | |||
|
|
|||
| The example shows how to create lines or rectangles that span the axes in either the horizontal or vertical direction. | |||
There was a problem hiding this comment.
The example shows how to
| @@ -3,6 +3,7 @@ | |||
| Axis Equal Demo | |||
| =============== | |||
|
|
|||
| This example how to set and adjust plots with equal axis ratios. | |||
| @@ -3,6 +3,7 @@ | |||
| Contourf Demo | |||
| ============= | |||
|
|
|||
| Example use of the `contourf` function to create filled contour plots. | |||
There was a problem hiding this comment.
Example use of How to use
| @@ -3,6 +3,7 @@ | |||
| Contourf Hatching | |||
| ================= | |||
|
|
|||
| Demo of filled contour plots with of hatched patterns. | |||
| @@ -29,6 +30,7 @@ | |||
| ) | |||
| plt.colorbar() | |||
|
|
|||
| ############################################################################### | |||
There was a problem hiding this comment.
let's remove this in lieu of the next PR
| @@ -3,6 +3,7 @@ | |||
| Figure Title | |||
| ============ | |||
|
|
|||
| Example use of `title` and `suptitle` to create subplot titles and a centered figure title, respectively. | |||
There was a problem hiding this comment.
`` not `
also, make sure this doesn't go over 79 characters...not sure if it does or not but it feels a little long to me :-)
| @@ -3,6 +3,7 @@ | |||
| Fill Betweenx Demo | |||
| ================== | |||
|
|
|||
| This example shows how to use `fill_betweenx` to color between two horizontal curves. | |||
There was a problem hiding this comment.
This example shows how to use Using
also `` not `
| @@ -3,6 +3,7 @@ | |||
| Plotfile Demo | |||
| ============= | |||
|
|
|||
| Example use of `plotfile` to plot data directly from a file. | |||
| @@ -3,6 +3,7 @@ | |||
| Simple Plot | |||
| =========== | |||
|
|
|||
| Simple example of a simple plot. | |||
There was a problem hiding this comment.
Simple example of Create
| @@ -3,6 +3,7 @@ | |||
| Specgram Demo | |||
There was a problem hiding this comment.
Let's call this Spectrogram Demo
| @@ -3,6 +3,7 @@ | |||
| Symlog Demo | |||
| =========== | |||
|
|
|||
| Example use of symlog (symmetrical log) axis scaling. | |||
There was a problem hiding this comment.
symmetric? not sure if I'm right there or not...probably fine either way
There was a problem hiding this comment.
Seems ok. It's shorter anyway :)
| @@ -3,6 +3,7 @@ | |||
| Xcorr Demo | |||
| ========== | |||
|
|
|||
| Example use of cross-correlation (`xcorr`) and auto-correlation (`acorr`) plots. | |||
| @@ -3,6 +3,7 @@ | |||
| Xcorr Demo | |||
|
Pushed some edits with the suggested changes |
| @@ -1,8 +1,9 @@ | |||
| """ | |||
| ========== | |||
| Xcorr Demo | |||
| Cross-correlation Demo | |||
There was a problem hiding this comment.
The title lines on this one need to be the same length as the title (which is what is failing travis)
|
@choldgraf Conficts addressed, finished with current changes |
| @@ -3,6 +3,7 @@ | |||
| Contourf Hatching | |||
| ================= | |||
|
|
|||
| Demo filled contour plots with of hatched patterns. | |||
| @@ -3,6 +3,7 @@ | |||
| Spine Placement Demo | |||
| ==================== | |||
|
|
|||
| This example demos how to adjust the location and appearance of axis spines. | |||
There was a problem hiding this comment.
This example demos how to adjust Adjusting
| Xcorr Demo | ||
| ========== | ||
| ============================ | ||
| Cross-/Auto-correlation Demo |
There was a problem hiding this comment.
how about "Cross- and Auto-Correlation Demo"?
|
A few small comments and after this LGTM |
|
done. |
|
@tonyyli Thanks and congratulations on your first Matplotlib contribution 🎉 |
|
Way to go @tonyyli ! And thanks for being patient during the review :-) |
PR Summary
I've added one-line descriptions to 19 examples that currently do not have them.
This partially addresses one of the issues mentioned in #8885 ("Ensure that all examples / tutorials have a title and a one-line description underneath").
@choldgraf @NelleV