diff options
| author | David Robillard <d@drobilla.net> | 2023-08-23 16:14:49 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2023-08-23 17:58:46 -0400 |
| commit | 36cd543badf1277039af83c8fe8b5bfa2a86280d (patch) | |
| tree | 6c78b6e55e56a3ad6b6fa3f4a20e3808ad8eb682 /doc | |
| parent | cfb97d0865e235458b186cc21cafe4367bce72f4 (diff) | |
| download | zix-36cd543badf1277039af83c8fe8b5bfa2a86280d.tar.gz zix-36cd543badf1277039af83c8fe8b5bfa2a86280d.tar.bz2 zix-36cd543badf1277039af83c8fe8b5bfa2a86280d.zip | |
Clean up and update documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/allocation.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/allocation.rst b/doc/allocation.rst index 5b9d507..819c7c4 100644 --- a/doc/allocation.rst +++ b/doc/allocation.rst @@ -17,8 +17,8 @@ which is equivalent to :func:`zix_default_allocator()`. Zix includes one implementation of a custom allocator, a very simple bump-pointer allocator which can be created with :func:`zix_bump_allocator`. -A convenience API for using a custom allocator if provided -(and the system allocator otherwise) -is provided with functions like :func:`zix_malloc` that correspond to those in the standard C API. +A convenience API for using custom allocators +(or the system allocator as a fallback) +is provided with functions like :func:`zix_malloc` that reflect the standard C API. Memory allocated with an allocator must be freed by calling :func:`zix_free` with the same allocator. |