docs: flush libmemcached progress

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

diff --git a/docs/source/libmemcached/memcached_exist.rst b/docs/source/libmemcached/memcached_exist.rst
index 60f5ae2a80ccd21646def19b2560f4bd7e9b8905..d93a220558e1b3a3651d0d75848038dba805547a 100644 (file)
--- a/docs/source/libmemcached/memcached_exist.rst
+++ b/docs/source/libmemcached/memcached_exist.rst
@@ -1,19 +1,22 @@
-===========================
-Determine if a keys exists.
-===========================
-
-.. index:: object: memcached_st
+Determine if a keys exists
+==========================
 
 SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+    Compile and link with -lmemcached
 
 .. function::  memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)
 
 .. function::  memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length)
 
-Compile and link with -lmemcached
+    :param ptr: pointer to an initialized `memcached_st` struct
+    :param group_key: the key namespace
+    :param group_key_length: length of the `group_key` without any terminating zero
+    :param key: the key to check
+    :param key_length: length of the `key` without any terminating zero
+    :returns: `memcached_return_t` indicating success
 
 .. versionadded:: 0.53
 
@@ -36,5 +39,12 @@ SEE ALSO
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_strerror(3)`
+
+.. only:: html
 
+    * :manpage:`memcached(1)`
+    * :doc:`../libmemcached`
+    * :doc:`memcached_strerror`