Skip to content

Commit 34ae012

Browse files
authored
Improve documentation (#492)
1 parent 0ffebf0 commit 34ae012

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.rst

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ Rules
4747
C400-402: Unnecessary generator - rewrite as a ``<list/set/dict>`` comprehension.
4848
---------------------------------------------------------------------------------
4949

50+
Rules:
51+
52+
* C400 Unnecessary generator - rewrite as a list comprehension.
53+
* C401 Unnecessary generator - rewrite as a set comprehension.
54+
* C402 Unnecessary generator - rewrite as a dict comprehension.
55+
5056
It's unnecessary to use ``list``, ``set``, or ``dict`` around a generator expression, since there are equivalent comprehensions for these types.
5157
For example:
5258

@@ -57,6 +63,11 @@ For example:
5763
C403-404: Unnecessary list comprehension - rewrite as a ``<set/dict>`` comprehension.
5864
-------------------------------------------------------------------------------------
5965

66+
Rules:
67+
68+
* C403 Unnecessary list comprehension - rewrite as a set comprehension.
69+
* C404 Unnecessary list comprehension - rewrite as a dict comprehension.
70+
6071
It's unnecessary to use a list comprehension inside a call to ``set`` or ``dict``, since there are equivalent comprehensions for these types.
6172
For example:
6273

@@ -66,6 +77,9 @@ For example:
6677
C405-406: Unnecessary ``<list/tuple>`` literal - rewrite as a ``<set/dict>`` literal.
6778
-------------------------------------------------------------------------------------
6879

80+
* C405 Unnecessary ``<list/tuple>`` literal - rewrite as a set literal.
81+
* C406 Unnecessary ``<list/tuple>`` literal - rewrite as a dict literal.
82+
6983
It's unnecessary to use a list or tuple literal within a call to ``set`` or ``dict``.
7084
For example:
7185

@@ -76,6 +90,11 @@ For example:
7690
* Rewrite ``dict(((1, 2),))`` as ``{1: 2}``
7791
* Rewrite ``dict([])`` as ``{}``
7892

93+
C407: Unnecessary ``<dict/list>`` comprehension - ``<builtin>`` can take a generator
94+
------------------------------------------------------------------------------------
95+
96+
This rule was dropped in version 3.4.0, because it promoted an increase in laziness which could lead to bugs.
97+
7998
C408: Unnecessary ``<dict/list/tuple>`` call - rewrite as a literal.
8099
--------------------------------------------------------------------
81100

@@ -88,8 +107,18 @@ For example:
88107
* Rewrite ``list()`` as ``[]``
89108
* Rewrite ``tuple()`` as ``()``
90109

91-
C409-410: Unnecessary ``<list/tuple>`` passed to ``<list/tuple>``\() - (remove the outer call to ``<list/tuple>``()/rewrite as a ``<list/tuple>`` literal).
92-
-----------------------------------------------------------------------------------------------------------------------------------------------------------
110+
C409-410: Unnecessary ``<list/tuple>`` passed to ``<list/tuple>``\() - ``<advice>``.
111+
------------------------------------------------------------------------------------
112+
113+
Rules:
114+
115+
* C409 Unnecessary ``<list/tuple>`` passed to tuple() - ``<advice>``.
116+
* C410 Unnecessary ``list passed to list() - ``<advice>``.
117+
118+
Where ``<advice>`` is either:
119+
120+
* remove the outer call to ``<list/tuple>``\()
121+
* rewrite as a ``<list/tuple>`` literal
93122

94123
It's unnecessary to use a list or tuple literal within a call to ``list`` or ``tuple``, since there is literal syntax for these types.
95124
For example:
@@ -109,6 +138,11 @@ For example:
109138

110139
* Rewrite ``list([f(x) for x in foo])`` as ``[f(x) for x in foo]``
111140

141+
C412: Unnecessary ``<dict/list/set>`` comprehension - 'in' can take a generator.
142+
--------------------------------------------------------------------------------
143+
144+
This rule was dropped in version 3.4.0, because it promoted an increase in laziness which could lead to bugs.
145+
112146
C413: Unnecessary ``<list/reversed>`` call around sorted().
113147
-----------------------------------------------------------
114148

0 commit comments

Comments
 (0)