sasl

[m6w6/libmemcached] / docs / memcached_delete.rst

diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst
index 5afccee7f4e5f3fe349e9a4a9c8c7b4bdd77f4dd..acea40fafcd7de40f523cd48de891afb776fdae4 100644 (file)
--- a/docs/memcached_delete.rst
+++ b/docs/memcached_delete.rst
@@ -2,6 +2,8 @@
 Deleting data from a server
 ===========================
 
+.. index:: object: memcached_st
+
 --------
 SYNOPSIS
 --------
@@ -20,13 +22,13 @@ DESCRIPTION
 -----------
 
 
-memcached_delete() is used to delete a particular key. 
-memcached_delete_by_key() works the same, but it takes a master key to
-find the given value.
+:c:func:`memcached_delete()` is used to delete a particular key. 
+:c:func:`memcached_delete_by_key()` works the same, but it takes a master key 
+to find the given value.
 
 Expiration works by placing the item into a delete queue, which means that
-it won't possible to retrieve it by the "get" command, but "add" and 
-"replace" command with this key will also fail (the "set" command will 
+it won't be possible to retrieve it by the "get" command. The "add" and 
+"replace" commands with this key will also fail (the "set" command will 
 succeed, however). After the time passes, the item is finally deleted from server memory.
 
 Please note the the Danga memcached server removed tests for expiration in
@@ -38,9 +40,10 @@ RETURN
 ------
 
 
-A value of type \ ``memcached_return_t``\  is returned
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return_t` is returned
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror()` to translate this value to a printable 
+string.
 
 If you are using the non-blocking mode of the library, success only
 means that the message was queued for delivery.