test: poll_timeout; see php-memcached-dev/php-memcached#531

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

diff --git a/docs/source/libmemcached/memcached_version.rst b/docs/source/libmemcached/memcached_version.rst
index 40c41b70f734a10e4b2e7a996230ad50288c3e08..9c7e840ea10627ad87bb983b2f9e9fa83b068cc3 100644 (file)
--- a/docs/source/libmemcached/memcached_version.rst
+++ b/docs/source/libmemcached/memcached_version.rst
@@ -1,30 +1,33 @@
-=======================================================
-Getting version information about the client and server
-=======================================================
+Getting version information
+===========================
 
---------
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+    Compile and link with -lmemcached
 
 .. function:: const char * memcached_lib_version (void)
 
+    :returns: version string of `libmemcached`
+
 .. function:: memcached_return_t memcached_version (memcached_st *ptr)
 
-Compile and link with -lmemcached
+    :param ptr: pointer to initialized `memcached_st` struct
+    :returns: `memcached_return_t` indicating success
 
------------
 DESCRIPTION
 -----------
 
-:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version)
+:func:`memcached_lib_version` is used to return a simple version string
+representing the `libmemcached` version (client library, not server).
 
-:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.
+:func:`memcached_version` is used to set the major, minor, and micro versions of
+each memcached server being used by the `memcached_st` connection structure.
+It returns the memcached server return code.
 
-------
-RETURN
-------
+RETURN VALUE
+------------
 
 :func:`memcached_lib_version` returns a string with the version of the libmemcached driver.
 
@@ -38,7 +41,6 @@ If called with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value
 Use :func:`memcached_strerror` to translate this value to
 a printable string.
 
---------
 SEE ALSO
 --------