You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/release_notes.rst
+55Lines changed: 55 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,61 @@ Release notes
17
17
For release notes (sparsely) kept prior to 1.0.0, look at the `releases page
18
18
on GitHub <https://github.com/numpy/numpydoc/releases>`__.
19
19
20
+
1.2.0
21
+
-----
22
+
23
+
Release date: 24 January 2022
24
+
25
+
Requires Python 3.7+ and Sphinx 1.8+.
26
+
27
+
Implemented enhancements
28
+
~~~~~~~~~~~~~~~~~~~~~~~~
29
+
30
+
- Document release process `#357 <https://github.com/numpy/numpydoc/pull/357>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
31
+
- Use setuptools `#349 <https://github.com/numpy/numpydoc/pull/349>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
32
+
- DOC: Switch docs to pydata-sphinx-theme `#313 <https://github.com/numpy/numpydoc/pull/313>`__ (`rossbar <https://github.com/rossbar>`__)
33
+
- Improve error messages for see also parsing `#306 <https://github.com/numpy/numpydoc/pull/306>`__ (`rossbar <https://github.com/rossbar>`__)
34
+
- ENH: Enable validation during sphinx-build process `#302 <https://github.com/numpy/numpydoc/pull/302>`__ (`rossbar <https://github.com/rossbar>`__)
35
+
- Add a note to the docstring standard about long ‘See Also’ entries. `#300 <https://github.com/numpy/numpydoc/pull/300>`__ (`WarrenWeckesser <https://github.com/WarrenWeckesser>`__)
36
+
- MAINT: minor refactoring in docscrape `#297 <https://github.com/numpy/numpydoc/pull/297>`__ (`rossbar <https://github.com/rossbar>`__)
- ENH: Better warning for sections. `#278 <https://github.com/numpy/numpydoc/pull/278>`__ (`Carreau <https://github.com/Carreau>`__)
39
+
40
+
Fixed bugs
41
+
~~~~~~~~~~
42
+
43
+
- How to specify that parameter can equal the string ‘integer’? `#341 <https://github.com/numpy/numpydoc/issues/341>`__
44
+
- Fix validation bug when parameter type is set of options. `#347 <https://github.com/numpy/numpydoc/pull/347>`__ (`rossbar <https://github.com/rossbar>`__)
45
+
- Escape newline in docstring. `#345 <https://github.com/numpy/numpydoc/pull/345>`__ (`Carreau <https://github.com/Carreau>`__)
46
+
- Correctly validate parameters under the “Other Parameters” section `#337 <https://github.com/numpy/numpydoc/pull/337>`__ (`dcbr <https://github.com/dcbr>`__)
47
+
- BUG: fix an incomplete check in ``Reader.\_error\_location`` `#308 <https://github.com/numpy/numpydoc/pull/308>`__ (`rgommers <https://github.com/rgommers>`__)
- BUG: Properly parse See Also when summary on first line. `#283 <https://github.com/numpy/numpydoc/pull/283>`__ (`Carreau <https://github.com/Carreau>`__)
52
+
- BUG: fix role regex. `#280 <https://github.com/numpy/numpydoc/pull/280>`__ (`Carreau <https://github.com/Carreau>`__)
53
+
- fix splitting of parameter lines. `#279 <https://github.com/numpy/numpydoc/pull/279>`__ (`Carreau <https://github.com/Carreau>`__)
54
+
55
+
Closed issues
56
+
~~~~~~~~~~~~~
57
+
58
+
- Class methods (@classmethod) are not documented using ``numpydoc`` `#340 <https://github.com/numpy/numpydoc/issues/340>`__
59
+
- Exclude certain methods from METHODS section `#338 <https://github.com/numpy/numpydoc/issues/338>`__
60
+
- Warnings is not allowed in “GL06” check `#334 <https://github.com/numpy/numpydoc/issues/334>`__
61
+
- Add version to style guide `#333 <https://github.com/numpy/numpydoc/issues/333>`__
62
+
- numpydoc does not render parameters as expected `#329 <https://github.com/numpy/numpydoc/issues/329>`__
0 commit comments