diff --git a/README.rst b/README.rst index f2de2698..9071c129 100644 --- a/README.rst +++ b/README.rst @@ -65,7 +65,7 @@ or as a directory — and you want to distribute it. flit publish -Once your package is published, people can install it using *pip* just like +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. diff --git a/SECURITY.md b/SECURITY.md index 54de41b5..7908f538 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,18 +6,18 @@ Only the latest non-prerelease version is supported. ## Security contact information -To report a security vulnerability +To report a security vulnerability: ### Directly on GitHub -You can also directly propose a GitHub security advisory on the Flit Security page of github: +You can directly propose a GitHub security advisory on the Flit Security page of GitHub: [https://github.com/pypa/flit/security](https://github.com/pypa/flit/security) -### via Tidelift: +### Via Tidelift: You can use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. -If you are a tidelift subscriber, this is the preferred path +If you are a Tidelift subscriber, this is the preferred path. diff --git a/doc/cmdline.rst b/doc/cmdline.rst index baac0275..90bfed9c 100644 --- a/doc/cmdline.rst +++ b/doc/cmdline.rst @@ -14,7 +14,7 @@ Common options Path to a config file specifying the module to build. The default is ``pyproject.toml``. -.. option:: --version +.. option:: --version Show the version of Flit in use. @@ -196,7 +196,7 @@ Flit guess. .. program:: flit init -Create a new ``pyproject.toml`` config file by prompting for information about +Create a new ``pyproject.toml`` config file by prompting for information about the module in the current directory. Environment variables diff --git a/doc/history.rst b/doc/history.rst index b1ed52cc..aaa89661 100644 --- a/doc/history.rst +++ b/doc/history.rst @@ -42,8 +42,8 @@ Version 3.10 or user tokens (:samp:`pypi_token:user:{username}`). - The ``--python`` option can now take the path of a virtualenv folder, as an alternative to a Python executable (:ghpull:`667`). -- Flit will work with current development versions of Pythona again (:ghpull:`684`). -- The ``flit`` command line package now requires Python 3.8 or above (:ghpulL:`660`). +- Flit will work with current development versions of Python again (:ghpull:`684`). +- The ``flit`` command line package now requires Python 3.8 or above (:ghpull:`660`). ``flit_core`` still works with Python 3.6 or above. - The metadata in packages now has the names of optional dependency groups ("extras") normalised, complying with version 2.3 of the metadata standard @@ -56,7 +56,7 @@ Version 3.10 (:ghpull:`674`). It's a good idea to always set a maximum version for the build requirement, to protect against changes in future major versions of Flit. - Avoid using the deprecated ``datetime.utcfromtimestamp()`` (:ghpull:`682`). -- Flit now has a ``SECURITY.md`` file in the Github repository (:ghpull:`665`). +- Flit now has a ``SECURITY.md`` file in the GitHub repository (:ghpull:`665`). - The tests for ``flit_core`` are no longer part of the installed package, reducing the size of the wheels (:ghpull:`691`). @@ -526,7 +526,7 @@ Version 0.8 ----------- - A new ``flit installfrom`` subcommand to install a project from a source - archive, such as from Github. + archive, such as from GitHub. - :doc:`Reproducible builds ` - you can produce byte-for-byte identical wheels. - A warning for non-canonical version numbers according to `PEP 440 diff --git a/doc/pyproject_toml.rst b/doc/pyproject_toml.rst index d663e690..644d2448 100644 --- a/doc/pyproject_toml.rst +++ b/doc/pyproject_toml.rst @@ -95,7 +95,7 @@ readme an optional ``content-type`` key (e.g. ``text/x-rst``). requires-python A version specifier for the versions of Python this requires, e.g. ``~=3.3`` or - ``>=3.3,<4``, which are equivalents. + ``>=3.3,<4``, which are equivalent. license A valid SPDX `license expression `_ or a table with either a ``file`` key (a relative path to a license file) or a @@ -115,7 +115,7 @@ classifiers Add ``Private :: Do Not Upload`` into the list to prevent a private package from being uploaded to PyPI by accident. import-names - A list containing the importable module name in this package. You don't + A list containing the importable module names in this package. You don't normally need to supply this manually, but you can specify it with a ``; private`` suffix to record that the module is not intended for public use. This does not stop anyone importing it. @@ -214,7 +214,7 @@ without a console. Entry points sections ~~~~~~~~~~~~~~~~~~~~~ -You can declare `entry points `_ +You can declare `entry points `_ using sections named :samp:`[project.entry-points.{groupname}]`. E.g. to provide a pygments lexer from your package: diff --git a/doc/upload.rst b/doc/upload.rst index df5af5ef..f764094e 100644 --- a/doc/upload.rst +++ b/doc/upload.rst @@ -14,8 +14,8 @@ you can configure Flit in two main ways: Using .pypirc ------------- -You can create or edit a config file in your home directory, ``~/.pypirc`` that -will be used by default or you can specify a custom location. +You can create or edit a config file in your home directory, ``~/.pypirc``, that +will be used by default, or you can specify a custom location. This is also used by other Python tools such as `twine `_.