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
DOC:Use monospace for -- #2242
Conversation
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?
👍 |
Is that a thumbs up for this change or for the proposed change of formatting all strings this way? |
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. |
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. |
Ok I changed them all in this file. I'll try to look in other files when I have time |
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? |
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. LGTM. I'm 👍 for merges. |
Should this also be done for strings on http://matplotlib.org/users/text_props.html ? |
@endolith: I think so. I've never cared for how Sphinx turns the |
Ok, did that too |
The
--
is rendering as an en dash on http://matplotlib.org/users/pyplot_tutorial.htmlMaybe all strings should use monospace instead of single quotes?