docs: flush libmemcached progress

[awesomized/libmemcached] / docs / source / libmemcached / configuration.rst

diff --git a/docs/source/libmemcached/configuration.rst b/docs/source/libmemcached/configuration.rst
index 8e9c4763847f88922e4ae2528b91a3f2f3798538..2bd67d55fc4acab4f5f1d9197e49bb486d966216 100644 (file)
--- a/docs/source/libmemcached/configuration.rst
+++ b/docs/source/libmemcached/configuration.rst
@@ -9,8 +9,18 @@ SYNOPSIS
 
 .. function:: memcached_st *memcached(const char *string, size_t string_length)
 
+    :param string: configuration string
+    :param string_length: length of the configuration string without any terminating zero
+    :returns: allocated and initialized `memcached_st` struct
+
 .. function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
 
+    :param option_string: configuration string
+    :param length: length of the configuration string without any terminating zero
+    :param error_buffer: buffer used to store any error message
+    :param error_buffer_size: available size of the `error_buffer`
+    :returns: `memcached_return_t` indicating success
+
 DESCRIPTION
 -----------
 
@@ -191,7 +201,7 @@ ENVIRONMENT
 RETURN VALUE
 ------------
 
-`memcached` returns a pointer to the memcached_st that was created (or
+`memcached` returns a pointer to the `memcached_st` that was created (or
 initialized).  On an allocation failure, it returns NULL.
 
 EXAMPLE