diff options
| author | David Robillard <d@drobilla.net> | 2022-11-17 12:07:21 -0500 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-11-17 12:09:45 -0500 |
| commit | 68d02a48ea89d45f16f7901bf46849ea923841c0 (patch) | |
| tree | dcab96020bd40c7e4d663d96701bba470abb08ce /doc/error_handling.rst | |
| parent | e0cb455ac899829cf9fe41bbd6015f5567a9bbcb (diff) | |
| download | zix-68d02a48ea89d45f16f7901bf46849ea923841c0.tar.gz zix-68d02a48ea89d45f16f7901bf46849ea923841c0.tar.bz2 zix-68d02a48ea89d45f16f7901bf46849ea923841c0.zip | |
Improve documentation
Diffstat (limited to 'doc/error_handling.rst')
| -rw-r--r-- | doc/error_handling.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/error_handling.rst b/doc/error_handling.rst new file mode 100644 index 0000000..331aa33 --- /dev/null +++ b/doc/error_handling.rst @@ -0,0 +1,13 @@ +.. + Copyright 2022 David Robillard <d@drobilla.net> + SPDX-License-Identifier: ISC + +Error Handling +============== + +.. default-domain:: c +.. highlight:: c + +Most functions return a :enum:`ZixStatus` which describes whether they succeeded (with zero, or :enumerator:`ZIX_STATUS_SUCCESS`) +or why they failed. +The human-readable message for a status can be retrieved with :func:`zix_strerror`. |