adding keyword plotting by choldgraf · Pull Request #8566 · matplotlib/matplotlib

choldgraf · 2017-05-04T03:51:11Z

Two short little snippets of code to demo plotting with keywords. In this case I'm using a dictionary but mention that you could use a DataFrame if you wanted. Mentioned in #8555

anntzer · 2017-05-04T05:01:36Z

examples/misc/keyword_plotting.py

+======================
+
+There are some instances where you have data in a format that lets you
+access particular variables with strings. For example, with a ``recarray``


At the risk of doing the rst markup police again and again: optimally, recarray and DataFrame should be in single backquotes. See e.g. https://raw.githubusercontent.com/anntzer/mplcursors/master/doc/index.rst, look for

:mod:`pandas`’ :class:`DataFrame <pandas.DataFrame>`\s,

rendered at http://mplcursors.readthedocs.io/en/latest/.

(Also check https://github.com/anntzer/mplcursors/blob/master/doc/conf.py#L349).

See also https://mail.zope.org/pipermail/grok-dev/2008-December/006823.html, https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#inline-markup-and-special-characters-e-g-bold-italic-verbatim.

choldgraf · 2017-05-04T05:55:04Z

that's a good point @anntzer - I actually noticed that it didn't seem like matplotlib had intersphinx activated. Any particular reason for that? Latest push activates the intersphinx extension and adds in some common packages. Also fixes the rst

anntzer · 2017-05-04T05:59:51Z

Probably because matplotlib's sphinx setup may predate intersphinx? (it is certainly based on a very old version of sphinx).

choldgraf · 2017-05-04T06:02:09Z

Probably because matplotlib's sphinx setup may predate intersphinx?

Not anymore! ;-)

dstansby · 2017-05-04T18:17:40Z

doc/conf.py


+intersphinx_mapping = {
+  'python': ('http://docs.python.org/', None),
+  'numpy': ('http://docs.scipy.org/doc/numpy-dev/', None),


We should link to the stable version of numpy docs (https://docs.scipy.org/doc/numpy/)

dstansby · 2017-05-04T18:18:06Z

doc/conf.py

+intersphinx_mapping = {
+  'python': ('http://docs.python.org/', None),
+  'numpy': ('http://docs.scipy.org/doc/numpy-dev/', None),
+  'scipy': ('http://scipy.github.io/devdocs/', None),


Same as above, this should be the stable version of the docs (https://docs.scipy.org/doc/scipy/reference/)

dstansby · 2017-05-04T18:18:40Z

examples/misc/keyword_plotting.py

@@ -0,0 +1,24 @@
+"""
+Plotting with keywords


This should have a line of = signs above the title too I think

story645 · 2017-05-04T18:39:27Z

examples/misc/keyword_plotting.py

+np.random.seed(19680801)
+
+data = dict([(label, np.random.randn(50)) for label in ['a', 'b', 'c', 'd']])
+data['d'] = np.abs(data['d']) * 100


Hmm, as much as it's more work in some ways, I feel like an example with a clear structure, so something like:

data = { 'a' : [1,2,3,4,5,5,6,7], 'b' :[4,5, 6,2,3, 4, 5], 'c': [3,1,2,3,4,5,6,3], 'd':[1,2,3,4,5,6,7,8]}

might work better since the point of this is to really clearly see what the kwarg does.

story645 · 2017-05-04T18:40:34Z

tutorials/01_introductory/pyplot.py

+# Matplotlib allows you provide such an object with
+# the ``data`` keyword argument. If provided, then you may generate plots with
+# the strings corresponding to these variables.
+


same as above

choldgraf · 2017-05-05T01:09:48Z

comments addressed!

choldgraf · 2017-05-05T01:48:23Z

ah I see - you mean using dict() vs {} yeah? I default to dict() because I think it's the most generally supported in earlier versions of python (maybe <2.7?) so I just default to it. If it's a problem I can use the curly brackets...

dstansby

👍

QuLogic · 2017-05-05T02:36:40Z

doc/conf.py

 autodoc_docstring_signature = True

+intersphinx_mapping = {
+  'python': ('http://docs.python.org/', None),


https also; would be nice if this intersphinx change were a separate commit.

choldgraf · 2017-05-05T02:53:11Z

latest version has curly brackets + https + intersphinx in a diff commit

story645

Thanks for putting up w/ my nitpicking. Same down here please.

choldgraf · 2017-05-05T03:14:09Z

Same down here please

down where? @story645

dstansby · 2017-05-05T03:14:39Z

tutorials/01_introductory/pyplot.py

+# Matplotlib allows you provide such an object with
+# the ``data`` keyword argument. If provided, then you may generate plots with
+# the strings corresponding to these variables.
+


oops - this is how you know I should probably stop coding for the day ;-)

QuLogic · 2017-05-05T04:24:49Z

doc/conf.py

+  'python': ('https://docs.python.org/', None),
+  'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+  'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
+  'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None)


This one's not accessible over https, unfortunately. Also, why two-space indent?

QuLogic · 2017-05-05T04:27:47Z

examples/misc/keyword_plotting.py

+
+fig, ax = plt.subplots()
+ax.scatter('a', 'b', c='c', s='d', data=data)
+ax.set(xlabel='a', ylabel='b')


Just to be clear, this doesn't try to somehow pull something out of data; maybe use something like 'Entry a'/'Column a' or similar to avoid implying that.

QuLogic · 2017-05-05T04:29:15Z

examples/misc/keyword_plotting.py

+:class:`numpy.recarray` or :class:`pandas.DataFrame`.
+
+Matplotlib allows you provide such an object with
+the ``data`` keyword argument. If provided, then you may generate plots with


Slightly over-eager wrapping.

How do you mean? Doesn't this need to be double ticks since it's rST?

I mean the line above this is wrapped at like 50 chars instead of 79.

oh - ok I removed the extra whitespace. is that such a big deal? I prefer to have extra whitespace as it makes it easier to reword etc without having to bump everything down a bunch of lines

Well, it's not major, but I just think it looks odd when one line is broken much earlier than the rest; it didn't even break at the end of a sentence.

choldgraf · 2017-05-05T04:36:07Z

ok comments addressed

story645 · 2017-05-05T04:37:21Z

Sorry, clicked on wrong thing and thought you hadn't changed both examples.

choldgraf · 2017-05-05T04:46:17Z

Sorry, clicked on wrong thing and thought you hadn't changed both examples

no you were right - I had missed the tutorial!

QuLogic · 2017-05-05T20:05:57Z

There seems to be some problems building the docs, but I'm not sure if it's this change or some external problem.

choldgraf · 2017-05-05T20:13:03Z

I think it's because the tutorial was using plt.plot and was getting the s kwarg which isn't valid for plot. Latest commit uses scatter which is what I was going for anyway.

dstansby · 2017-05-05T21:35:39Z

Seems to be all working now!

choldgraf · 2017-05-05T21:38:50Z

🍻

QuLogic · 2017-05-07T04:33:51Z

BTW, wherever you originally wrote the commit and where you updated it seem to disagree on your name/email.

choldgraf · 2017-05-07T17:30:55Z

ah that's annoying - I made a commit from my lab computer, must have been set up w a different address. thanks for noticing

QuLogic · 2017-05-16T05:05:34Z

doc/_static/mpl.css


 a {
-    color: #CA7900;
+    color: #CA7900 !important;


Why make this change? Links no longer change colour on hover.

the reason for this was to make the inline links show up within sphinx-gallery pages (they weren't showing up before). I didn't realize this was going to mess up the other links as well. A better way for me to have done this would be to add a new rule instead:

div.highlight-python a { color: #CA7900 !important; }

want me to add this commit to the toolkits PR?

This is fixed in the toolkit PR, works fine now and should be merged soon! Good find

Would that require a :hover rule as well?

yep there's a new hover in there too

choldgraf mentioned this pull request May 4, 2017

Final documentation improvements #8555

Closed

11 tasks

anntzer reviewed May 4, 2017

View reviewed changes

choldgraf force-pushed the adding_data_kwarg branch from fd1ef5d to 0ed3497 Compare May 4, 2017 05:54

choldgraf force-pushed the adding_data_kwarg branch from 0ed3497 to b97d6ec Compare May 4, 2017 05:58

dstansby requested changes May 4, 2017

View reviewed changes

story645 reviewed May 4, 2017

View reviewed changes

dstansby added the Documentation label May 4, 2017

dstansby added this to the 2.1 (next point release) milestone May 4, 2017

choldgraf force-pushed the adding_data_kwarg branch from b97d6ec to 512b4eb Compare May 5, 2017 01:09

dstansby reviewed May 5, 2017

View reviewed changes

dstansby changed the title ~~adding keyword plotting~~ [MRG+1] adding keyword plotting May 5, 2017

dstansby approved these changes May 5, 2017

View reviewed changes

QuLogic reviewed May 5, 2017

View reviewed changes

choldgraf added 2 commits May 4, 2017 19:50

adding keyword plotting

596ceec

adding intersphinx

c3f5715

choldgraf force-pushed the adding_data_kwarg branch from 512b4eb to c3f5715 Compare May 5, 2017 02:50

story645 reviewed May 5, 2017

View reviewed changes

dstansby reviewed May 5, 2017

View reviewed changes

choldgraf force-pushed the adding_data_kwarg branch from 12b80fe to a24ca89 Compare May 5, 2017 03:17

QuLogic reviewed May 5, 2017

View reviewed changes

choldgraf force-pushed the adding_data_kwarg branch from a24ca89 to 2e9a8c2 Compare May 5, 2017 04:35

choldgraf force-pushed the adding_data_kwarg branch from 2e9a8c2 to 4de797f Compare May 5, 2017 04:37

story645 approved these changes May 5, 2017

View reviewed changes

choldgraf force-pushed the adding_data_kwarg branch from 4de797f to 57aa332 Compare May 5, 2017 20:12

curly brackets dict

b7e31f3

choldgraf force-pushed the adding_data_kwarg branch from 57aa332 to b7e31f3 Compare May 5, 2017 21:06

dstansby merged commit e232afe into matplotlib:master May 5, 2017

dstansby changed the title ~~[MRG+1] adding keyword plotting~~ adding keyword plotting May 5, 2017

QuLogic reviewed May 16, 2017

View reviewed changes

Uh oh!

Conversation

choldgraf commented May 4, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

choldgraf commented May 4, 2017

Uh oh!

anntzer commented May 4, 2017

Uh oh!

choldgraf commented May 4, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

choldgraf commented May 5, 2017

Uh oh!

choldgraf commented May 5, 2017

Uh oh!

dstansby left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

choldgraf commented May 5, 2017

Uh oh!

story645 left a comment

Choose a reason for hiding this comment

Uh oh!

choldgraf commented May 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

choldgraf commented May 5, 2017

Uh oh!

story645 commented May 5, 2017

Uh oh!

choldgraf commented May 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QuLogic commented May 5, 2017

Uh oh!

choldgraf commented May 5, 2017

Uh oh!

dstansby commented May 5, 2017

Uh oh!

choldgraf commented May 5, 2017

Uh oh!

QuLogic commented May 7, 2017

Uh oh!

choldgraf commented May 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

choldgraf commented May 5, 2017 •

edited

Loading

choldgraf commented May 5, 2017 •

edited

Loading

choldgraf May 16, 2017 •

edited

Loading