-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Update README.rst #6535
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
Update README.rst #6535
Conversation
@@ -18,17 +18,17 @@ For installation instructions and requirements, see the INSTALL file. | |||
Testing | |||
======= | |||
|
|||
After installation, you can launch the test suite:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The double ::
is rst markup, can you please leave those?
quality figures in a variety of hardcopy formats and interactive | ||
environments across platforms. matplotlib can be used in python | ||
scripts, the python and ipython shell (ala matlab or mathematica), web | ||
matplotlib is a Python 2D plotting library which produces publication-quality |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can/should matplotlib be capitalized? There is one instance of it on this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was discussion of this on the mailing list, but I do not thing there was a conclusive answer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds familiar, and I don't remember the outcome, either. I would say, though, that the lack of capitalization at the start of a sentence looks terrible. Matplotlib certainly should be capitalized there, so the remaining question is whether it should be capitalized everywhere. I think it should be. I don't see any disadvantages. It looks like that is the practice with Python, based on a very quick look at python.org. Same with IPython and Jupyter. Pandas is lower case, but italicized--that only works with styled text, so I don't consider it a good model.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The capitalization discussion was triggered by me for my book. The
conclusion I drew from it was to treat it as a proper noun, which is what I
did in my book. I think what was also acceptable is to treat it just simply
as a regular noun, but to stop doing lower-casing the name if it is the
first word of the sentence.
On Mon, Jun 6, 2016 at 2:13 PM, Eric Firing [email protected]
wrote:
In README.rst
#6535 (comment):@@ -2,10 +2,10 @@
matplotlib
##########-matplotlib is a python 2D plotting library which produces publication
-quality figures in a variety of hardcopy formats and interactive
-environments across platforms. matplotlib can be used in python
-scripts, the python and ipython shell (ala matlab or mathematica), web
+matplotlib is a Python 2D plotting library which produces publication-qualitySounds familiar, and I don't remember the outcome, either. I would say,
though, that the lack of capitalization at the start of a sentence looks
terrible. Matplotlib certainly should be capitalized there, so the
remaining question is whether it should be capitalized everywhere. I think
it should be. I don't see any disadvantages. It looks like that is the
practice with Python, based on a very quick look at python.org. Same with
IPython and Jupyter. Pandas is lower case, but italicized--that only works
with styled text, so I don't consider it a good model.—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
https://github.com/matplotlib/matplotlib/pull/6535/files/61e288eabc4a02ce5474dc705274e1109184a61f#r65939985,
or mute the thread
https://github.com/notifications/unsubscribe/AARy-PxSeVe1_qq-mEzb-NS-y-1nzgU7ks5qJGNLgaJpZM4IuTy8
.
@PeterMortensen it looks like your PR would be ready to merge with a few changes based on the review comments. Will you be able to make the changes soon? |
ping @PeterMortensen |
superseded by #6768 due to inactivity |
DOC: update README Takeover #6535
DOC: update README Takeover #6535
Copy edited (e.g. ref. http://en.wikipedia.org/wiki/Python_%28programming_language%29, http://en.wikipedia.org/wiki/IPython, http://en.wikipedia.org/wiki/MATLAB, and http://en.wikipedia.org/wiki/Mathematica).