summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorAnthony Sottile <asottile@umich.edu>2019-07-28 14:48:47 +0000
committerAnthony Sottile <asottile@umich.edu>2019-07-28 14:48:47 +0000
commite8de432f8e81e8bcf6fbffabe35b320cc2dafcae (patch)
tree0aadd9cc9ec1c5c2f2ec0d528030d05262018589 /docs/source
parent862b17d229454e31e312217237bfe65f90effbe8 (diff)
parent1757bce321c8276b6fad77ce15766f0c81e46957 (diff)
downloadflake8-e8de432f8e81e8bcf6fbffabe35b320cc2dafcae.tar.gz
Merge branch 'simplify-normalize-paths' into 'master'
Hoist comma-separated string parsing out of path normalization See merge request pycqa/flake8!334
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/internal/utils.rst15
1 files changed, 5 insertions, 10 deletions
diff --git a/docs/source/internal/utils.rst b/docs/source/internal/utils.rst
index 31e0d39..fed9a47 100644
--- a/docs/source/internal/utils.rst
+++ b/docs/source/internal/utils.rst
@@ -25,13 +25,8 @@
"E121,W123,F904"
"E121,\nW123,\nF804"
- "E121,\n\tW123,\n\tF804"
-
-Or it will take a list of strings (potentially with whitespace) such as
-
-.. code-block:: python
-
- [" E121\n", "\t\nW123 ", "\n\tF904\n "]
+ " E121,\n\tW123,\n\tF804 "
+ " E121\n\tW123 \n\tF804"
And converts it to a list that looks as follows
@@ -50,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