Skip to content

Commit

Permalink
docs: address review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
  • Loading branch information
henryiii committed Mar 27, 2024
1 parent b41feba commit 90c33a5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
8 changes: 5 additions & 3 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ New Features:

* Two simple ``py::set_error()`` functions were added and the documentation was
updated accordingly. In particular, ``py::exception<>::operator()`` was
deprecated (use one of the new function instead). The documentation for
deprecated (use one of the new functions instead). The documentation for
``py::exception<>`` was further updated to not suggest code that may result
in undefined behavior.
`#4772 <https://github.com/pybind/pybind11/pull/4772>`_
Expand All @@ -52,8 +52,8 @@ Bug fixes:
`#4893 <https://github.com/pybind/pybind11/pull/4893>`_

* ``pybind11/numpy.h`` now imports NumPy's ``multiarray`` and ``_internal``
submodules with paths depending on the version of installed NumPy (handling
change in NumPy 2.0).
submodules with paths depending on the installed version of NumPy (for
compatibility with NumPy 2).
`#4857 <https://github.com/pybind/pybind11/pull/4857>`_

* Builtins collections names in docstrings are now consistently rendered in
Expand Down Expand Up @@ -85,6 +85,7 @@ Bug fixes:
somewhere else, such as modernjson's concat.
`#4955 <https://github.com/pybind/pybind11/pull/4955>`_

.. fix(types)
* Render typed iterators for ``make_iterator``, ``make_key_iterator``,
``make_value_iterator``.
Expand All @@ -107,6 +108,7 @@ Bug fixes:
list, set, and function.
`#4259 <https://github.com/pybind/pybind11/pull/4259>`_

.. fix(build)
* Fix FindPython mode exports & avoid ``pkg_resources`` if
``importlib.metadata`` available.
Expand Down
3 changes: 2 additions & 1 deletion tools/make_changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@
for cat, msgs in cats.items():
if msgs:
desc = cats_descr[cat]
print(f"[bold]{desc}:\n\n" if desc else "", end="")
print(f"[bold]{desc}:" if desc else f".. {cat}")
print()
for msg in msgs:
print(Syntax(msg, "rst", theme="ansi_light", word_wrap=True))
print()
Expand Down

0 comments on commit 90c33a5

Please sign in to comment.