X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_exist.rst;h=d93a220558e1b3a3651d0d75848038dba805547a;hb=f013c48684ce1d405dc80815139b31282a2a48f5;hp=84fca3413766afb1db3767be939f41e91d71beb3;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=awesomized%2Flibmemcached

diff --git a/docs/source/libmemcached/memcached_exist.rst b/docs/source/libmemcached/memcached_exist.rst
index 84fca341..d93a2205 100644
--- a/docs/source/libmemcached/memcached_exist.rst
+++ b/docs/source/libmemcached/memcached_exist.rst
@@ -1,35 +1,32 @@
-===========================
-Determine if a keys exists.
-===========================
+Determine if a keys exists
+==========================
 
-.. index:: object: memcached_st
-
---------
 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
 
-
------------
 DESCRIPTION
 -----------
 
 :func:`memcached_exist()` can be used to check if a key exists.
 
-
-------
-RETURN
-------
+RETURN VALUE
+------------
 
 `MEMCACHED_SUCCESS`
   The key exists.
@@ -37,12 +34,17 @@ RETURN
 `MEMCACHED_NOTFOUND`
   The key was not found.
 
---------
 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`