Skip to content

Commit 47e67b5

Browse files
Fix documentation typos, grammar, and formatting inconsistencies
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: DimitriPapadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
1 parent 25e6027 commit 47e67b5

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ or as a directory — and you want to distribute it.
6565

6666
flit publish
6767

68-
Once your package is published, people can install it using *pip* just like
68+
Once your package is published, people can install it using pip just like
6969
any other package. In most cases, pip will download a 'wheel' package, a
7070
standard format it knows how to install. If you specifically ask pip to install
7171
an 'sdist' package, it will install and use Flit in a temporary environment.

SECURITY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ Only the latest non-prerelease version is supported.
66

77
## Security contact information
88

9-
To report a security vulnerability
9+
To report a security vulnerability:
1010

1111
### Directly on GitHub
1212

13-
You can also directly propose a GitHub security advisory on the Flit Security page of github:
13+
You can directly propose a GitHub security advisory on the Flit Security page of GitHub:
1414

1515
[https://github.com/pypa/flit/security](https://github.com/pypa/flit/security)
1616

17-
### via Tidelift:
17+
### Via Tidelift:
1818

1919
You can use the
2020
[Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the
2121
fix and disclosure.
2222

23-
If you are a tidelift subscriber, this is the preferred path
23+
If you are a Tidelift subscriber, this is the preferred path.

doc/cmdline.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Common options
1414
Path to a config file specifying the module to build. The default is
1515
``pyproject.toml``.
1616

17-
.. option:: --version
17+
.. option:: --version
1818

1919
Show the version of Flit in use.
2020

@@ -196,7 +196,7 @@ Flit guess.
196196

197197
.. program:: flit init
198198

199-
Create a new ``pyproject.toml`` config file by prompting for information about
199+
Create a new ``pyproject.toml`` config file by prompting for information about
200200
the module in the current directory.
201201

202202
Environment variables

doc/history.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Version 3.10
4242
or user tokens (:samp:`pypi_token:user:{username}`).
4343
- The ``--python`` option can now take the path of a virtualenv folder, as an
4444
alternative to a Python executable (:ghpull:`667`).
45-
- Flit will work with current development versions of Pythona again (:ghpull:`684`).
46-
- The ``flit`` command line package now requires Python 3.8 or above (:ghpulL:`660`).
45+
- Flit will work with current development versions of Python again (:ghpull:`684`).
46+
- The ``flit`` command line package now requires Python 3.8 or above (:ghpull:`660`).
4747
``flit_core`` still works with Python 3.6 or above.
4848
- The metadata in packages now has the names of optional dependency groups
4949
("extras") normalised, complying with version 2.3 of the metadata standard
@@ -56,7 +56,7 @@ Version 3.10
5656
(:ghpull:`674`). It's a good idea to always set a maximum version for the
5757
build requirement, to protect against changes in future major versions of Flit.
5858
- Avoid using the deprecated ``datetime.utcfromtimestamp()`` (:ghpull:`682`).
59-
- Flit now has a ``SECURITY.md`` file in the Github repository (:ghpull:`665`).
59+
- Flit now has a ``SECURITY.md`` file in the GitHub repository (:ghpull:`665`).
6060
- The tests for ``flit_core`` are no longer part of the installed package,
6161
reducing the size of the wheels (:ghpull:`691`).
6262

@@ -526,7 +526,7 @@ Version 0.8
526526
-----------
527527

528528
- A new ``flit installfrom`` subcommand to install a project from a source
529-
archive, such as from Github.
529+
archive, such as from GitHub.
530530
- :doc:`Reproducible builds <reproducible>` - you can produce byte-for-byte
531531
identical wheels.
532532
- A warning for non-canonical version numbers according to `PEP 440

doc/pyproject_toml.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ readme
9595
an optional ``content-type`` key (e.g. ``text/x-rst``).
9696
requires-python
9797
A version specifier for the versions of Python this requires, e.g. ``~=3.3`` or
98-
``>=3.3,<4``, which are equivalents.
98+
``>=3.3,<4``, which are equivalent.
9999
license
100100
A valid SPDX `license expression <https://peps.python.org/pep-0639/#term-license-expression>`_
101101
or a table with either a ``file`` key (a relative path to a license file) or a
@@ -115,7 +115,7 @@ classifiers
115115
Add ``Private :: Do Not Upload`` into the list to prevent a private package
116116
from being uploaded to PyPI by accident.
117117
import-names
118-
A list containing the importable module name in this package. You don't
118+
A list containing the importable module names in this package. You don't
119119
normally need to supply this manually, but you can specify it with a
120120
``; private`` suffix to record that the module is not intended for public use.
121121
This does not stop anyone importing it.
@@ -214,7 +214,7 @@ without a console.
214214
Entry points sections
215215
~~~~~~~~~~~~~~~~~~~~~
216216

217-
You can declare `entry points <http://entrypoints.readthedocs.io/en/latest/>`_
217+
You can declare `entry points <https://entrypoints.readthedocs.io/en/latest/>`_
218218
using sections named :samp:`[project.entry-points.{groupname}]`. E.g. to
219219
provide a pygments lexer from your package:
220220

doc/upload.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ you can configure Flit in two main ways:
1414
Using .pypirc
1515
-------------
1616

17-
You can create or edit a config file in your home directory, ``~/.pypirc`` that
18-
will be used by default or you can specify a custom location.
17+
You can create or edit a config file in your home directory, ``~/.pypirc``, that
18+
will be used by default, or you can specify a custom location.
1919
This is also used by other Python tools such as `twine
2020
<https://pypi.python.org/pypi/twine>`_.
2121

0 commit comments

Comments
 (0)