Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos in Core API docs on error management. #764

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Fix typos in Core API docs on error management. #764

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/api_core.rst
View file
Open in desktop
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