aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2017-04-02 13:05:25 -0400
committerJack Lloyd <[email protected]>2017-04-02 13:05:25 -0400
commit7428afb6b36546d120df6f9bb1d1409f68866542 (patch)
tree8058b96c5fada63a60a583a16073e6d089963b44 /doc
parentdb73b2e64c344836afd2160f0610e350bb07da2e (diff)
Fix doc formatting
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/ffi.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/manual/ffi.rst b/doc/manual/ffi.rst
index 61b61b7b1..f5f004624 100644
--- a/doc/manual/ffi.rst
+++ b/doc/manual/ffi.rst
@@ -342,7 +342,8 @@ Multiple Precision Integers
.. cpp:function:: int botan_mp_to_uint32(const botan_mp_t x, uint32_t* val)
- If x fits in a 32-bit integer, set *val to it and return 0.
+ If x fits in a 32-bit integer, set val to it and return 0. If x is out of
+ range an error is returned.
.. cpp:function:: int botan_mp_cmp(int* result, botan_mp_t x, botan_mp_t y)