File: HISTORY.rst

package info (click to toggle)
flake8-docstrings 1.7.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 124 kB
  • sloc: python: 142; makefile: 2
file content (151 lines) | stat: -rw-r--r-- 2,788 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
History/Changelog
=================

1.7.0
-----

- Add ``--property-decorators`` option.

1.6.0
-----

- Fix ``--ignore-noqa`` by disabling ``pydocstyle``'s ``noqa`` handling.

1.5.0
-----

- Add ``--ignore-decorators`` option which allows functions with a specific
  decorator to ignore error codes.

1.4.0
-----

- Add ``--docstring-convention`` option which allows selection of conventions
  besides the default ``pep257``.  Available options are based on those
  available from ``pydocstyle`` and are currently ``pep257``, ``google``, and
  ``numpy``.  ``flake8-docstrings`` also adds a special ``all`` docstring
  convention which will enable all rules from ``pydocstyle``.  Note that
  ``pydocstyle`` defines some conflicting rules so you'll want to use
  ``ignore`` / ``extend-ignore`` when selecting ``docstring-convention = all``

- Bump minimum flake8 version to 3

- Fix proper handling of ``stdin`` via ``--stdin-display-name``

1.3.1
-----

- Fix incompatibility with pydocstyle 4.x

1.3.0
-----

- Bump minimum pydocstyle version to 2.1.0

1.2.0
-----

- Fix EnvironError and AllError invocations

- Avoid Flake8 warning for requesting ``builtins``

1.1.0
-----

- Upgrade dependency on pydocstyle to 2.0.0

1.0.3
-----

- Use flake8-polyfill to get standard-in to handle Flake8 3.x and 2.x

1.0.2
-----

- Use pycodestyle to get standard-in.

1.0.1
-----

- Make sure this works out of the box (is enabled by default) with Flake8 3.0

1.0.0
-----

- Switch dependency name to pydocstyle. pep257 was renamed to pydocstyle, this
  update switches the requirement to that new package name. Since we're
  swapping out dependencies, we've issued a major version bump.

0.2.7
-----

- Try to import pydocstyle (not pycodestyle) as pep257

0.2.6
-----

- Respect pep257's default ignore list

- Handle AllError and other exceptions from pep257

0.2.5
-----

- Use pep257's ``tokenize_open`` function to pass input to the tool.

- Use pep257's conventions so any error codes that are ignored by default
  using ``pep257`` are also ignored by default with this plugin.

0.2.4
-----

- Fix bug introduced in 0.2.2 where the file source was always None causing
  D100 and D104 errors for all files and no other errors to be found.

0.2.3
-----

- Remove extraneous space in error message.

- Fix up how the plugin displays with ``flake8 --version``.

0.2.2
-----

- Better support for input provided via stdin.

0.2.1
-----

- Prevent AllError or EnvironmentErrors from being raised. Thanks Alex
  Pyrgiotis.

0.2.0
-----

- Upgrade to pep257 0.3.0

0.1.4
-----

- Stop truncating error messages

0.1.3
-----

- Really fix the installation issue this time.

0.1.2
-----

- Actually fix the PyPI release. **Ugh**

0.1.1
-----

- Fix the PyPI release.

0.1.0
-----

- Initial Release!