From e5daca098ed812c23d4fcb8fdc6f09ee84a4d649 Mon Sep 17 00:00:00 2001 From: Wenzel Jakob Date: Mon, 2 Sep 2024 15:46:41 +0900 Subject: [PATCH] Documentation fixes --- docs/api_cmake.rst | 4 ++-- docs/api_extra.rst | 2 +- docs/changelog.rst | 4 ++-- docs/faq.rst | 1 + tests/py_stub_test.py | 2 -- 5 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/api_cmake.rst b/docs/api_cmake.rst index d19d408b..c8718176 100644 --- a/docs/api_cmake.rst +++ b/docs/api_cmake.rst @@ -15,7 +15,7 @@ If you prefer another build system, then you have the following options: Please report Bazel-specific issues there. - `Will Ayd `__ has created a `Meson WrapDB - package https://mesonbuild.com/Wrapdb-projects.html>`__ for nanobind. Please + package `__ for nanobind. Please report Meson-specific issues on the `Meson WrapDB `__ repository. @@ -66,7 +66,7 @@ The high-level interface consists of just one CMake command: * - ``STABLE_ABI`` - Perform a `stable ABI - `_ build, making it + `__ build, making it possible to use a compiled extension across Python minor versions. The flag is ignored on Python versions older than < 3.12. * - ``NB_STATIC`` diff --git a/docs/api_extra.rst b/docs/api_extra.rst index 4f8d8acd..7f1c0215 100644 --- a/docs/api_extra.rst +++ b/docs/api_extra.rst @@ -664,7 +664,7 @@ section `. .. cpp:class:: template ndarray - .. cpp:var:: ReadOnly + .. cpp:var:: static constexpr bool ReadOnly A constant static boolean that is true if the array's data is read-only. This is determined by the class template arguments, not by any dynamic diff --git a/docs/changelog.rst b/docs/changelog.rst index 606532e8..763604b3 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -54,7 +54,7 @@ Version 2.1.0 (Aug 11, 2024) `__ (PR `#618 `__). -* Improved handling of ``const`-ness in :cpp:class:`nb::ndarray ` (PR +* Improved handling of ``const``-ness in :cpp:class:`nb::ndarray ` (PR `#491 `__). * Keyword argument annotations are now properly supported with @@ -278,7 +278,7 @@ noteworthy: generally do have interned keyword arguments) should be unaffected. (PR `#469 `__). -* The ``owner=nb::handle()`` default value of the :cpp:func:`nb::ndarray +* The ``owner=nb::handle()`` default value of the :cpp:class:`nb::ndarray ` constructor was removed since it was bug-prone. You now have to specify the owner explicitly. The previous default (``nb::handle()``) continues to be a valid argument. diff --git a/docs/faq.rst b/docs/faq.rst index 62d0d965..3ad499d2 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -84,6 +84,7 @@ other types when they are handled using :ref:`type casters `. Please read the full section on :ref:`information exchange between C++ and Python ` to understand the issue and alternatives. +.. _leak-checker: Why am I getting errors about leaked functions and types? --------------------------------------------------------- diff --git a/tests/py_stub_test.py b/tests/py_stub_test.py index 2269a457..6053376a 100644 --- a/tests/py_stub_test.py +++ b/tests/py_stub_test.py @@ -66,5 +66,3 @@ def overloaded_2(self, x: str) -> None: ... def overloaded_2(self, x): "docstr 3" - -del typing