Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC:Use monospace for -- #2242

Merged
merged 3 commits into from Sep 17, 2013
Merged

DOC:Use monospace for -- #2242

merged 3 commits into from Sep 17, 2013

Conversation

endolith
Copy link
Contributor

The -- is rendering as an en dash on http://matplotlib.org/users/pyplot_tutorial.html

Maybe all strings should use monospace instead of single quotes?

The -- is rendering as an en dash on http://matplotlib.org/users/pyplot_tutorial.html

Maybe all strings should use monospace instead of single quotes?
@mdboom
Copy link
Member

mdboom commented Jul 23, 2013

👍

@endolith
Copy link
Contributor Author

Is that a thumbs up for this change or for the proposed change of formatting all strings this way?

@WeatherGod
Copy link
Member

Heh, I thought I found all instances of this back in the day, or maybe someone undid what I had done? Just to note, when I went around fixing this issue, I did monospaced with single quotes inside them in order to help distinguish between the string "none" and the python None.

@mdboom
Copy link
Member

mdboom commented Jul 23, 2013

Good point about the single quotes inside, @WeatherGod. I think that's important here.

I'm 👍 on this (modulo @WeatherGod's suggestion about including the single quotes inside, i.e.:

``'--'``

and I'm also 👍 on doing this everywhere strings are mentioned, if anyone is willing to take that on.

@endolith
Copy link
Contributor Author

Ok I changed them all in this file. I'll try to look in other files when I have time

@pelson
Copy link
Member

pelson commented Aug 1, 2013

I think this is in direct conflict with the numpydoc HOWTO: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#documenting-classes - I'd be keen to get consensus on this with the numpydoc guys to avoid anybody spending effort on what could prove to be a backwards step... @NelleV - do you have any comment?

@NelleV
Copy link
Member

NelleV commented Aug 1, 2013

This is in the tutorial, hence not linked to numpydoc. The difference is that people will not read this unrendered, hence I'm 👍 on the changes.
I would be against such changes in the docstrings on the over hand.

LGTM. I'm 👍 for merges.

@endolith
Copy link
Contributor Author

endolith commented Aug 1, 2013

Should this also be done for strings on http://matplotlib.org/users/text_props.html ?

@mdboom
Copy link
Member

mdboom commented Aug 1, 2013

@endolith: I think so. I've never cared for how Sphinx turns the '' into ‘’ in that case, and using the monospace mode for those strings should also fix that.

@endolith
Copy link
Contributor Author

endolith commented Aug 2, 2013

Ok, did that too

mdboom added a commit that referenced this pull request Sep 17, 2013
@mdboom mdboom merged commit 5c6f2a1 into matplotlib:master Sep 17, 2013
@endolith endolith deleted the patch-3 branch September 17, 2013 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants