Skip to content

Commit

Permalink
Typos in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn committed Oct 30, 2018
1 parent 1758c43 commit 95f16ff
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Namespaces are one honking great idea -- let's do more of those!
pip install wemake-python-styleguide
```

You will also need to create a `setup.cfg` file with [the following contents](https://wemake-python-styleguide.readthedocs.io/en/latest/_pages/options/config.html#third-party-plugins).
You will also need to create a `setup.cfg` file with [the following contents](https://wemake-python-styleguide.readthedocs.io/en/latest/_pages/options/config.html#plugins).

This file is required to configure our linter and all 3rd party plugins it uses.
However, this is a temporary solution.
Expand Down
2 changes: 1 addition & 1 deletion docs/_pages/options/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Config
======

.. automodule:: wemake_python_styleguide.options.config
:members:
:no-members:

Defaults
--------
Expand Down
4 changes: 2 additions & 2 deletions wemake_python_styleguide/options/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ class Configuration(object):
definition, defaults to
:str:`wemake_python_styleguide.options.defaults.MAX_BASE_CLASSES`
All options are configurable via ``flake8`` CLI:
All options are configurable via ``flake8`` CLI.
Example::
flake8 --max-returns=2 --max-arguments=4
Or you can provide options in ``tox.ini`` or ``setup.cfg``:
Or you can provide options in ``tox.ini`` or ``setup.cfg``.
Example::
Expand Down
24 changes: 12 additions & 12 deletions wemake_python_styleguide/options/defaults.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,41 +18,41 @@

# General:

#: Minimum variable's name length:
#: Minimum variable's name length.
MIN_NAME_LENGTH: Final = 2

#: Whether you control ones who use your code:
#: Whether you control ones who use your code.
I_CONTROL_CODE: Final = True


# Complexity:

#: Maximum number of `return` statements allowed in a single function:
#: Maximum number of `return` statements allowed in a single function.
MAX_RETURNS: Final = 5

#: Maximum number of local variables in a function:
#: Maximum number of local variables in a function.
MAX_LOCAL_VARIABLES: Final = 5

#: Maximum number of expressions in a single function:
#: Maximum number of expressions in a single function.
MAX_EXPRESSIONS: Final = 9

#: Maximum number of arguments for functions or method, `self` is not counted:
#: Maximum number of arguments for functions or method, `self` is not counted.
MAX_ARGUMENTS: Final = 5

#: Maximum number of classes and functions in a single module:
#: Maximum number of classes and functions in a single module.
MAX_MODULE_MEMBERS: Final = 7

#: Maximum number of methods in a single class:
#: Maximum number of methods in a single class.
MAX_METHODS: Final = 7

#: Maximum line complexity:
#: Maximum line complexity.
MAX_LINE_COMPLEXITY: Final = 14 # 7 * 2, also almost guessed

#: Maximum median module Jones complexity:
#: Maximum median module Jones complexity.
MAX_JONES_SCORE: Final = 12 # this value was "guessed"

#: Maximum number of imports in a single module:
#: Maximum number of imports in a single module.
MAX_IMPORTS: Final = 12

#: Maximum number of base classes:
#: Maximum number of base classes.
MAX_BASE_CLASSES: Final = 3

0 comments on commit 95f16ff

Please sign in to comment.