Skip to content

Commit

Permalink
Fix typos in Core API docs on error management.
Browse files Browse the repository at this point in the history
  • Loading branch information
hpkfft committed Oct 18, 2024
1 parent 2d1723c commit 60015b8
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/api_core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1391,49 +1391,49 @@ the reference section on :ref:`class binding <class_binding>`.

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``StopIteration`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: builtin_exception index_error(const char * what = nullptr)

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``IndexError`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: builtin_exception key_error(const char * what = nullptr)

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``KeyError`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: builtin_exception value_error(const char * what = nullptr)

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``ValueError`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: builtin_exception type_error(const char * what = nullptr)

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``TypeError`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: builtin_exception buffer_error(const char * what = nullptr)

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``BufferError`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: builtin_exception import_error(const char * what = nullptr)

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``ImportError`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: builtin_exception attribute_error(const char * what = nullptr)

Convenience wrapper to create a :cpp:class:`builtin_exception` C++ exception
instance that nanobind will re-raise as a Python ``AttributeError`` exception
boundary. when it crosses the C++ ↔ Python interface.
when it crosses the C++ ↔ Python interface.

.. cpp:function:: void register_exception_translator(void (* exception_translator)(const std::exception_ptr &, void*), void * payload = nullptr)

Expand Down

0 comments on commit 60015b8

Please sign in to comment.