Skip to content

Commit

Permalink
Fix two small documentation issues (#3297)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
srenfo and pre-commit-ci[bot] authored Jun 20, 2024
1 parent 8bf2fbd commit a261614
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/changelog/3297.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Fix typo in configuration example and fix broken link to code style guide. - by :user:`srenfo`
2 changes: 1 addition & 1 deletion docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1061,7 +1061,7 @@ Or reset override and append to that (note the first override is ``=`` and not `
Set CLI flags via environment variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
All CLI flags can be set via environment variables too, the naming convention here is ``TOX_<option>``. E.g.
``TOX_WORKDIR`` sets the ``--workdir`` flag, or ``TOX_OVERRIDE`` sets the ``--override`` flag. For flags accepting more
``TOX_WORK_DIR`` sets the ``--workdir`` flag, or ``TOX_OVERRIDE`` sets the ``--override`` flag. For flags accepting more
than one argument, use the ``;`` character to separate these values:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you're already experienced with submitting GitHub PRs to open-source Python p
points you need to know about this project. (If you're not, you should carefully read all the documentation after this
section. This section contains only highlights; it's not a substitute for reading this entire file.)

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

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

0 comments on commit a261614

Please sign in to comment.