diff options
| author | Eric N. Vander Weele <ericvw@gmail.com> | 2019-07-28 10:39:27 -0400 |
|---|---|---|
| committer | Eric N. Vander Weele <ericvw@gmail.com> | 2019-07-28 10:43:06 -0400 |
| commit | 1ba56b9056fd60dbb0f991fe5a4ac0bb6ad85cb9 (patch) | |
| tree | ec59e09c49d61a785ec2b9b2ccf67c0d3395e98a /docs | |
| parent | a0cd55fd6d2697f4823d1de24c9dda5858b27610 (diff) | |
| download | flake8-1ba56b9056fd60dbb0f991fe5a4ac0bb6ad85cb9.tar.gz | |
utils: Change `normalize_paths()` contract
The `normalize_paths()` utility was doing too much — parsing
unstructured configuration path data and dispatching the scrubbed paths
to be normalized.
Towards moving the parsing of unstructured configuration path data
closer towards were configuration occurs, have the utility accept only
structured input for normalizing paths.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/internal/utils.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/source/internal/utils.rst b/docs/source/internal/utils.rst index 2b2638e..fed9a47 100644 --- a/docs/source/internal/utils.rst +++ b/docs/source/internal/utils.rst @@ -45,9 +45,9 @@ path if the string has a ``/`` in it. It also removes trailing ``/``\ s. .. autofunction:: flake8.utils.normalize_paths -This function utilizes :func:`~flake8.utils.parse_comma_separated_list` and -:func:`~flake8.utils.normalize_path` to normalize its input to a list of -strings that should be paths. +This function utilizes :func:`~flake8.utils.normalize_path` to normalize a +sequence of paths. See :func:`~flake8.utils.normalize_path` for what defines a +normalized path. .. autofunction:: flake8.utils.stdin_get_value |