diff options
| author | Pradyun Gedam <3275593+pradyunsg@users.noreply.github.com> | 2020-10-26 18:09:26 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-26 18:09:26 +0530 |
| commit | ea74bd3d9085234601a0a6199b2ad65c6b6a002f (patch) | |
| tree | 92b80f6db87a6621e49be451415ae6eb6505d6a1 | |
| parent | cffc3a618edb74b5852e628afeb2ee9c097327b1 (diff) | |
| parent | 279e735969f609d927cce7e41576e46149c758c0 (diff) | |
| download | pip-ea74bd3d9085234601a0a6199b2ad65c6b6a002f.tar.gz | |
Merge pull request #9014 from McSinyx/docs-news-rst
Update docs for less common news extension
| -rw-r--r-- | docs/html/development/contributing.rst | 16 | ||||
| -rw-r--r-- | news/e1831861-84a4-4f9b-9987-762e127cb42b.trivial.rst | 0 |
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/html/development/contributing.rst b/docs/html/development/contributing.rst index 3d2d5ead0..3cdbb309d 100644 --- a/docs/html/development/contributing.rst +++ b/docs/html/development/contributing.rst @@ -109,22 +109,22 @@ A trivial change is anything that does not warrant an entry in the news file. Some examples are: Code refactors that don't change anything as far as the public is concerned, typo fixes, white space modification, etc. To mark a PR as trivial a contributor simply needs to add a randomly named, empty file to -the ``news/`` directory with the extension of ``.trivial``. If you are on a +the ``news/`` directory with the extension of ``.trivial.rst``. If you are on a POSIX like operating system, one can be added by running -``touch news/$(uuidgen).trivial``. On Windows, the same result can be achieved -in Powershell using ``New-Item "news/$([guid]::NewGuid()).trivial"``. Core -committers may also add a "trivial" label to the PR which will accomplish the -same thing. +``touch news/$(uuidgen).trivial.rst``. On Windows, the same result can be +achieved in Powershell using ``New-Item "news/$([guid]::NewGuid()).trivial"``. +Core committers may also add a "trivial" label to the PR which will accomplish +the same thing. Upgrading, removing, or adding a new vendored library gets a special mention -using a ``news/<library>.vendor`` file. This is in addition to any features, +using a ``news/<library>.vendor.rst`` file. This is in addition to any features, bugfixes, or other kinds of news that pulling in this library may have. This uses the library name as the key so that updating the same library twice doesn't produce two news file entries. Changes to the processes, policies, or other non code related changed that are -otherwise notable can be done using a ``news/<name>.process`` file. This is not -typically used, but can be used for things like changing version schemes, +otherwise notable can be done using a ``news/<name>.process.rst`` file. This is +not typically used, but can be used for things like changing version schemes, updating deprecation policy, etc. diff --git a/news/e1831861-84a4-4f9b-9987-762e127cb42b.trivial.rst b/news/e1831861-84a4-4f9b-9987-762e127cb42b.trivial.rst new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/news/e1831861-84a4-4f9b-9987-762e127cb42b.trivial.rst |