Skip to content

Commit a87f876

Browse files
Add 1.2 release notes (#359)
1 parent 631828f commit a87f876

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

doc/release_notes.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,61 @@ Release notes
1717
For release notes (sparsely) kept prior to 1.0.0, look at the `releases page
1818
on GitHub <https://github.com/numpy/numpydoc/releases>`__.
1919

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>`__)
37+
- ENH: Add configuration option for parameter cross-referencing `#295 <https://github.com/numpy/numpydoc/pull/295>`__ (`rossbar <https://github.com/rossbar>`__)
38+
- 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>`__)
48+
- MAINT: pytest ignore doc directory. `#296 <https://github.com/numpy/numpydoc/pull/296>`__ (`rossbar <https://github.com/rossbar>`__)
49+
- DOC: fix inaccuracy in validate docstring. `#294 <https://github.com/numpy/numpydoc/pull/294>`__ (`rossbar <https://github.com/rossbar>`__)
50+
- Fix param parsing. `#286 <https://github.com/numpy/numpydoc/pull/286>`__ (`Carreau <https://github.com/Carreau>`__)
51+
- 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>`__
63+
- 1.1.0: pytest warnings `#324 <https://github.com/numpy/numpydoc/issues/324>`__
64+
- RTD configuration - ``latest`` `#321 <https://github.com/numpy/numpydoc/issues/321>`__
65+
- Rendering of types in latest doc build `#318 <https://github.com/numpy/numpydoc/issues/318>`__
66+
- Anchors for individual sections in numpydoc doc? `#317 <https://github.com/numpy/numpydoc/issues/317>`__
67+
- Development documentation not up-to-date `#311 <https://github.com/numpy/numpydoc/issues/311>`__
68+
- Warning: autosummary: stub file not found `#290 <https://github.com/numpy/numpydoc/issues/290>`__
69+
- Wrong number of Parameter for numpy array. `#285 <https://github.com/numpy/numpydoc/issues/285>`__
70+
- syntax to document default values `#284 <https://github.com/numpy/numpydoc/issues/284>`__
71+
- Failed See Also Parsing. `#281 <https://github.com/numpy/numpydoc/issues/281>`__
72+
- Sphinx emits “WARNING: py:class reference target not found” with numpydoc 1.1.0 `#275 <https://github.com/numpy/numpydoc/issues/275>`__
73+
74+
2075
1.1.0
2176
-----
2277

0 commit comments

Comments
 (0)