Grammarly #921
Merged
Grammarly #921
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The subject of this section is finding examples of excellent code, not "readability matters".
dbader
reviewed
Sep 25, 2018
| One of the core tenets behind the design of Python is creating | ||
| readable code. The motivation behind this design is simple: The number | ||
| one thing that Python programmers do is read code. | ||
|
|
There was a problem hiding this comment.
I'm thinking this paragraph works quite well—did you want to remove it entirely?
There was a problem hiding this comment.
I think this paragraph is a good intro to issues of style, formatting, and PEP-8, but I think this section is about a different topic.
There was a problem hiding this comment.
So yes, I would remove it.
dbader
reviewed
Sep 25, 2018
docs/writing/reading.rst
Outdated
| @@ -28,12 +24,12 @@ reading. Each one of these projects is a paragon of Python coding. | |||
| - `Diamond <https://github.com/python-diamond/Diamond>`_ | |||
| Diamond is a python daemon that collects metrics | |||
| and publishes them to Graphite or other backends. | |||
| It is capable of collecting cpu, memory, network, i/o, load and disk metrics. | |||
| It is capable of collecting cpu, memory, network, i/o, load, and disk metrics. | |||
There was a problem hiding this comment.
Should we use capitals for "CPU" and "I/O"?
There was a problem hiding this comment.
Agreed, CPU and I/O should be upper case.
|
@mpoulin Added some comments—merge at will Marc 😃 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please have a look before I merge.
I make some grammar/punctuation fixes. Also, I deleted the first paragraph. It didn't seem to fit the overall theme of this section.