<div dir="ltr">Pull requests to improve the documentation are always welcome :)<div><br></div><div>You seem to have a clear idea of what would be helpful to include in that docstring, could you please add it?<br><div><div><br></div><div>Tom</div></div></div></div><br><div class="gmail_quote"><div dir="ltr">On Tue, Jan 10, 2017 at 1:38 PM Michael Kaufman <<a href="mailto:kaufmanmc@ornl.gov">kaufmanmc@ornl.gov</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On 1/10/17 1:18 PM, Thomas Caswell wrote:<br class="gmail_msg">
> It is also documented<br class="gmail_msg">
> at <a href="http://matplotlib.org/2.0.0rc2/users/colors.html" rel="noreferrer" class="gmail_msg" target="_blank">http://matplotlib.org/2.0.0rc2/users/colors.html</a> which is too verbose<br class="gmail_msg">
> to put into the docstring of every method (almost all of them) that<br class="gmail_msg">
> takes in a color-like input.<br class="gmail_msg">
><br class="gmail_msg">
<br class="gmail_msg">
Ok, but we've already got a nice paragraph:<br class="gmail_msg">
<br class="gmail_msg">
     In addition, you can specify colors in many weird and<br class="gmail_msg">
     wonderful ways, including full names (``'green'``), hex<br class="gmail_msg">
     strings (``'#008000'``), RGB or RGBA tuples (``(0,1,0,1)``) or<br class="gmail_msg">
     grayscale intensities as a string (``'0.8'``).  Of these, the<br class="gmail_msg">
     string specifications can be used in place of a ``fmt`` group,<br class="gmail_msg">
     but the tuple forms can be used only as ``kwargs``.<br class="gmail_msg">
<br class="gmail_msg">
in help(plot) that has just about everything except the new stuff anyway.<br class="gmail_msg">
<br class="gmail_msg">
Besides, help(plot) is the go-to method that (I at least) use if I want<br class="gmail_msg">
to look up the usage a kwarg. If it's there, then I can use (say the<br class="gmail_msg">
marker symbol) in scatter without needing the extensive extra<br class="gmail_msg">
documentation in help(scatter).<br class="gmail_msg">
<br class="gmail_msg">
So having help(plot) extra-documented makes plenty of sense for me.<br class="gmail_msg">
<br class="gmail_msg">
M<br class="gmail_msg">
<br class="gmail_msg">
> Additionally, we will be adding alias to access the color by name for<br class="gmail_msg">
> 2.0 final (see <a href="https://github.com/matplotlib/matplotlib/pull/7639" rel="noreferrer" class="gmail_msg" target="_blank">https://github.com/matplotlib/matplotlib/pull/7639</a> )<br class="gmail_msg">
><br class="gmail_msg">
> Tom<br class="gmail_msg">
</blockquote></div>