Skip to content

Commit a261614

Browse files
Fix two small documentation issues (#3297)
* Fix typo in configuration example * Fix link in development docs * Add changelog fragment * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 8bf2fbd commit a261614

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

docs/changelog/3297.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- Fix typo in configuration example and fix broken link to code style guide. - by :user:`srenfo`

docs/config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1061,7 +1061,7 @@ Or reset override and append to that (note the first override is ``=`` and not `
10611061
Set CLI flags via environment variables
10621062
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10631063
All CLI flags can be set via environment variables too, the naming convention here is ``TOX_<option>``. E.g.
1064-
``TOX_WORKDIR`` sets the ``--workdir`` flag, or ``TOX_OVERRIDE`` sets the ``--override`` flag. For flags accepting more
1064+
``TOX_WORK_DIR`` sets the ``--workdir`` flag, or ``TOX_OVERRIDE`` sets the ``--override`` flag. For flags accepting more
10651065
than one argument, use the ``;`` character to separate these values:
10661066

10671067
.. code-block:: bash

docs/development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If you're already experienced with submitting GitHub PRs to open-source Python p
88
points you need to know about this project. (If you're not, you should carefully read all the documentation after this
99
section. This section contains only highlights; it's not a substitute for reading this entire file.)
1010

11-
- Check the `style guide <#style-guide>`_ below. Note that ``tox -e fix`` will not catch the following:
11+
- Check the `style guide <#code-style-guide>`_ below. Note that ``tox -e fix`` will not catch the following:
1212

1313
- Lines wrapped at less than 120 characters. Lines should be wrapped at 120 characters, not the PEP-8 standard of 79.
1414
- Variable names should be at least two characters long.

0 commit comments

Comments
 (0)