Skip to content

Commit ba0b891

Browse files
StanFromIrelandpganssle
authored andcommitted
Few fixes to the maintaining doc
Corrects the name of the tox environment used, one malformed command and one malformed version.
1 parent 9a7e6a0 commit ba0b891

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/maintaining.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ repository root, and it is updated in two ways:
5050

5151
1. The "base version" (e.g. 2020.1) is set by ``tox -e update``.
5252
2. The additional markers such as pre (release candidate), post and dev are
53-
managed by ``tox -e bump_version``.
53+
managed by ``tox -e bump``.
5454

5555
The version follows the scheme::
5656

5757
YYYY.minor[rcX][.postY][.devZ]
5858

5959
Bumping any component removes all values to its right as well, so for example,
60-
if the base version were ``20201rc1.post2.dev0``::
60+
if the base version were ``2020.1rc1.post2.dev0``::
6161

6262
$ tox -e bump -- --dev --dry-run
6363
...
@@ -78,8 +78,8 @@ To remove all additional markers and get a simple "release" version, use
7878
...
7979
2020.1rc1.post2.dev0 → 2020.1
8080

81-
For more information on how to use ``bump_version``, run ``tox -e bump_version
82-
-- -help``.
81+
For more information on how to use ``bump_version``, run ``tox -e bump
82+
-- --help``.
8383

8484
Making a release
8585
----------------
@@ -112,4 +112,4 @@ is immutable and each release burns a version number.
112112

113113
.. Links
114114
.. |tox| replace:: ``tox``
115-
.. _tox: https://tox.readthedocs.io/en/latest/
115+
.. _tox: https://tox.wiki/en/latest/

0 commit comments

Comments
 (0)