Skip to content

Commit

Permalink
Fix(docs): error in section Formatter (#3044)
Browse files Browse the repository at this point in the history
  • Loading branch information
imtoopunkforyou authored Aug 27, 2024
1 parent b18703f commit eac9aa3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Semantic versioning in our case means:
### Misc

- Integration with `ondivi` doc for legacy codebases

- Fixes a documentation error for the Formatter (Showing statistic) section

## 0.19.2

Expand Down
12 changes: 9 additions & 3 deletions docs/pages/usage/formatter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,20 @@ We include ``show-source = True`` into our default configuration.

.. rubric:: Showing statistic

You can also show the statistics about problems inside your code.
You can also enable ``--statistics`` option.
It can be passed as a command line argument or set in ``setup.cfg``:

.. code:: ini
[flake8]
statistics = True
It will group all violations by type and tell how many of them
do you have and where you have them:

.. code::
» flake8 . --format=wemake --show-source --statistic
» flake8 . --format=wemake --show-source --statistics
./wemake_python_styleguide/formatter.py
Expand All @@ -91,7 +97,7 @@ do you have and where you have them:
All errors: 2
We do not include ``show-statistic`` in our default configuration.
We do not include ``statistics = True`` in our default configuration.
It should be only called when user needs to find how many violations
there are and what files do contain them.

Expand Down

0 comments on commit eac9aa3

Please sign in to comment.