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.

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

Jump to bottom

Documentation changes. #666

Closed
wants to merge 6 commits into from
Closed

Documentation changes. #666

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4502521
Update README.rst
grandell1234 Nov 9, 2023
37f5414
Update README.rst
grandell1234 Nov 9, 2023
e972ef3
Update README.rst
grandell1234 Nov 9, 2023
dbf0ce9
Update README.rst
grandell1234 Nov 9, 2023
9c337e7
Update README.rst
grandell1234 Nov 9, 2023
4460af9
Update README.rst
grandell1234 Nov 9, 2023
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
12 changes: 9 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

mistakes.
See `Why use Flit? <https://flit.readthedocs.io/en/latest/rationale.html>`_ for
more about how it compares to other Python packaging tools.
Expand All @@ -11,6 +11,12 @@ Install

$ python3 -m pip install flit

or

::

$ pip3 install flit

Flit requires Python 3 and therefore needs to be installed using the Python 3
version of pip.

Expand Down Expand Up @@ -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.

command line scripts. See the
`pyproject.toml page <https://flit.readthedocs.io/en/latest/pyproject_toml.html#scripts-section>`_
of the documentation.
Expand All @@ -68,7 +74,7 @@ or as a directory — and you want to distribute it.
Once your package is published, people can install it using *pip* just like
any other package. In most cases, pip will download a 'wheel' package, a
standard format it knows how to install. If you specifically ask pip to install
an 'sdist' package, it will install and use Flit in a temporary environment.
a 'sdist' package, it will install and use Flit in a temporary environment.
grandell1234 marked this conversation as resolved.
Show resolved Hide resolved


To install a package locally for development, run::
Expand Down