X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fmemcached_delete.rst;h=acea40fafcd7de40f523cd48de891afb776fdae4;hb=9c5fa1db34c5fb1ffed88742caeffa5a9afd0a9e;hp=f628f69e96a68e887f15bc4880c8961aacb15a8d;hpb=67456d74f5bd4f354a360d70da503dc58cbe5971;p=m6w6%2Flibmemcached diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst index f628f69e..acea40fa 100644 --- 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,9 +22,9 @@ 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 be possible to retrieve it by the "get" command. The "add" and @@ -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.