As a follow up of #7205, some docstrings of the basic Axes plotting methods could need a bit care. In particular:
- Conversion to numpydoc format.
- Improvements on the descriptions.
I intend to go through the methods and update their docs. This is a summary issue to keep track of my progress:
Basic
Spans
Spectral
Statistics
Binned
Contours
Array
Unstructured triangles
Text and Annotations
Fields
Axes limits and direction
Axes scales
Note: I currently update the docstrings in my private branch https://github.com/timhoffm/matplotlib/tree/axes-plotting-docstrings and will provide a pull request once I'm done. I think this is better than opening a separate pull request for every change. Please let me know, in case you'd rather prefer many smaller PRs.
The fixes will be supplied in a series of PRs referencing this issue.
As a follow up of #7205, some docstrings of the basic Axes plotting methods could need a bit care. In particular:
I intend to go through the methods and update their docs. This is a summary issue to keep track of my progress:
Basic
Axes.plotAxes.errorbarAxes.scatterAxes.plot_dateAxes.stepAxes.loglogAxes.semilogxAxes.semilogyAxes.fill_betweenAxes.fill_betweenxAxes.barAxes.barhAxes.stemAxes.eventplotAxes.pieAxes.stackplotAxes.broken_barhAxes.vlinesAxes.hlinesAxes.fillSpans
Axes.axhlineAxes.axhspanAxes.axvlineAxes.axvspanSpectral
Axes.acorrAxes.angle_spectrumAxes.cohereAxes.csdAxes.magnitude_spectrumAxes.phase_spectrumAxes.psdAxes.specgramAxes.xcorrStatistics
Axes.boxplotAxes.violinplotAxes.violinAxes.bxpBinned
Axes.hexbinAxes.histAxes.hist2dContours
Axes.clabelAxes.contourAxes.contourfArray
Axes.imshowAxes.matshowAxes.pcolorAxes.pcolorfastAxes.pcolormeshAxes.spyUnstructured triangles
Axes.tripcolorAxes.triplotAxes.tricontourAxes.tricontourfText and Annotations
Axes.annotateAxes.textAxes.tableAxes.arrowFields
Axes.barbsAxes.quiverAxes.quiverkeyAxes.streamplotAxes limits and direction
Axes.invert_xaxisAxes.xaxis_invertedAxes.invert_yaxisAxes.yaxis_invertedAxes.set_xlimAxes.get_xlimAxes.set_ylimAxes.get_ylimAxes.update_datalimAxes.update_datalim_boundsAxes.set_xboundAxes.get_xboundAxes.set_yboundAxes.get_yboundAxes scales
Axes.get_xscaleAxes.set_xscaleAxes.get_yscaleAxes.set_yscaleNote: I currently update the docstrings in my private branch https://github.com/timhoffm/matplotlib/tree/axes-plotting-docstrings and will provide a pull request once I'm done. I think this is better than opening a separate pull request for every change. Please let me know, in case you'd rather prefer many smaller PRs.The fixes will be supplied in a series of PRs referencing this issue.