Documentation fixes

wjakob · Sep 3, 2024 · e5daca0 · e5daca0
1 parent 9ff844d
commit e5daca0
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 7 deletions.
diff --git 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 <https://github.com/WillAyd/>`__ has created a `Meson WrapDB
-  package https://mesonbuild.com/Wrapdb-projects.html>`__ for nanobind. Please
+  package <https://mesonbuild.com/Wrapdb-projects.html>`__ for nanobind. Please
   report Meson-specific issues on the `Meson WrapDB
   <https://github.com/mesonbuild/wrapdb/issues>`__ repository.
 
@@ -66,7 +66,7 @@ The high-level interface consists of just one CMake command:
 
       * - ``STABLE_ABI``
         - Perform a `stable ABI
-          <https://docs.python.org/3/c-api/stable.html>`_ build, making it
+          <https://docs.python.org/3/c-api/stable.html>`__ 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
@@ -664,7 +664,7 @@ section <ndarrays>`.
 
 .. cpp:class:: template <typename... Args> 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
@@ -54,7 +54,7 @@ Version 2.1.0 (Aug 11, 2024)
   <https://github.com/scikit-build/scikit-build-core>`__ (PR `#618
   <https://github.com/wjakob/nanobind/discussions/618>`__).
 
-* Improved handling of ``const`-ness in :cpp:class:`nb::ndarray <ndarray>` (PR
+* Improved handling of ``const``-ness in :cpp:class:`nb::ndarray <ndarray>` (PR
   `#491 <https://github.com/wjakob/nanobind/discussions/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
   <https://github.com/wjakob/nanobind/pull/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
   <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
@@ -84,6 +84,7 @@ other types when they are handled using :ref:`type casters <type_casters>`.
 Please read the full section on :ref:`information exchange between C++ and
 Python <exchange>` 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
@@ -66,5 +66,3 @@ def overloaded_2(self, x: str) -> None: ...
 
     def overloaded_2(self, x):
         "docstr 3"
-
-del typing