Skip to content

Grammarly #921

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.

Sign up for GitHub

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

Merged
mpoulin merged 4 commits into from
Sep 25, 2018
Merged

Grammarly #921

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d0541c
Added missing comma
PoulinConsulting Sep 24, 2018
3bdbae8
Fixed grammar.
PoulinConsulting Sep 24, 2018
71b2afa
Deleted first paragraph
PoulinConsulting Sep 24, 2018
29be1ba
Capitalize CPU and I/O
mpoulin Sep 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions docs/writing/reading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ Reading Great Code

.. image:: /_static/photos/34689452831_93d7fd0571_k_d.jpg

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.

@dbader dbader Sep 25, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking this paragraph works quite well—did you want to remove it entirely?

@mpoulin mpoulin Sep 25, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@mpoulin mpoulin Sep 25, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So yes, I would remove it.

@dbader dbader Sep 25, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Makes sense!

One of the secrets of becoming a great Python programmer is to read,
understand, and comprehend excellent code.

Expand All @@ -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.
Additionally, it features an API for implementing custom collectors
for gathering metrics from almost any source.

- `Werkzeug <https://github.com/mitsuhiko/werkzeug>`_
Werkzeug started as simple collection of various utilities for WSGI
Werkzeug started as a simple collection of various utilities for WSGI
applications and has become one of the most advanced WSGI utility modules.
It includes a powerful debugger, full-featured request and response objects,
HTTP utilities to handle entity tags, cache control headers, HTTP dates,
Expand Down