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 36b1bc49e5498c5c6a25bdb89d33a54e89fdfbb3..2bd67d55fc4acab4f5f1d9197e49bb486d966216 100644 (file)
--- a/docs/source/libmemcached/configuration.rst
+++ b/docs/source/libmemcached/configuration.rst
@@ -4,13 +4,23 @@ libmemcached Configuration
 SYNOPSIS
 --------
 
-#include <libmemcached-1.0/memcached.h>
+#include <libmemcached-|libmemcached_version|/memcached.h>
   Compile and link with -lmemcached
 
 .. 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
 -----------
 
@@ -25,18 +35,18 @@ General Options:
 
     Provide a servername to be used by the client.
 
-    Providing a weight will cause weighting to occur with all hosts with each 
+    Providing a weight will cause weighting to occur with all hosts with each
     server getting a default weight of 1.
 
 .. describe:: --SOCKET=\"<filepath>/?<optional_weight>\"
 
-    Provide a filepath to a UNIX socket file. Providing a weight will cause 
-    weighting to occur with all hosts with each server getting a default weight 
+    Provide a filepath to a UNIX socket file. Providing a weight will cause
+    weighting to occur with all hosts with each server getting a default weight
     of 1.
 
 .. describe:: --VERIFY-KEY
 
-    Verify that keys that are being used fit within the design of the protocol 
+    Verify that keys that are being used fit within the design of the protocol
     being used.
 
 .. describe:: --REMOVE_FAILED_SERVERS
@@ -169,7 +179,7 @@ Other Options:
 .. describe:: INCLUDE
 
     Include a file in configuration.
-    Unlike --CONFIGURE-FILE= this will not reset `memcached_st`.
+    Unlike ``--CONFIGURE-FILE=`` this will not reset `memcached_st`.
 
 .. describe:: RESET
 
@@ -191,8 +201,8 @@ ENVIRONMENT
 RETURN VALUE
 ------------
 
-:func:`memcached()` returns a pointer to the memcached_st that was
-created (or initialized).  On an allocation failure, it returns NULL.
+`memcached` returns a pointer to the `memcached_st` that was created (or
+initialized).  On an allocation failure, it returns NULL.
 
 EXAMPLE 
 -------