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

Documentation changes. #666

Closed
wants to merge 6 commits into from
Closed

Documentation changes. #666

wants to merge 6 commits into from

Conversation

grandell1234
Copy link

In this request I fixed a few grammatical errors and added in another way to install Flit using pip3 install flit instead of python3 -m pip install flit.

Copy link
Contributor

@joukewitteveen joukewitteveen left a comment

Choose a reason for hiding this comment

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

Apart from mentioning pip3 install flit, I think these changes are no good.

@@ -1,5 +1,5 @@
**Flit** is a simple way to put Python packages and modules on PyPI.
It tries to require less thought about packaging and help you avoid common
It tries to require less thought about packaging and helps you avoid common
Copy link
Contributor

Choose a reason for hiding this comment

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

"to require [...] and help" seems correct to me. "to require [...] and to help" is a bit redundant. The suggested "it tries to require [...] and [it] helps" can work, but I would not say it is better.

@@ -53,7 +59,7 @@ or as a directory — and you want to distribute it.
[project.urls]
Home = "https://github.com/sirrobin/foobar"

You can edit this file to add other metadata, for example to set up
You can edit this file to add other metadata, for example, to set up
Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't add this comma since the example is setting up command line scripts, not the addition of other metadata.

README.rst Show resolved Hide resolved
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.

3 participants