docs: sanitize

[m6w6/libmemcached] / docs / source / libmemcached / memcached_flush.rst

diff --git a/docs/source/libmemcached/memcached_flush.rst b/docs/source/libmemcached/memcached_flush.rst
index 661d8e6a41b511a53c0773bd31d8e7ebce2a4328..071a989ff1fe2608b50ddbdafb0179ac9d67f738 100644 (file)
--- a/docs/source/libmemcached/memcached_flush.rst
+++ b/docs/source/libmemcached/memcached_flush.rst
@@ -1,4 +1,3 @@
-=====================================

 Wiping clean the contents of a server
 =====================================
 
 Wiping clean the contents of a server
 =====================================
 


@@ -6,24 +5,18 @@ Wiping clean the contents of a server
 
 Wipe contents of memcached servers
 
 
 Wipe contents of memcached servers
 

-
---------

 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
 

-

 #include <libmemcached/memcached.h>
 #include <libmemcached/memcached.h>

- 
+

 .. function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
 
 Compile and link with -lmemcached
 
 .. function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
 
 Compile and link with -lmemcached
 

-
------------

 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------
 

-

 :func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers.
 It will either do this immediately or expire the content based on the
 expiration time passed to the method (a value of zero causes an immediate
 :func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers.
 It will either do this immediately or expire the content based on the
 expiration time passed to the method (a value of zero causes an immediate


@@ -31,18 +24,13 @@ flush). The operation is not atomic to multiple servers, just atomic to a
 single server. That is, it will flush the servers in the order that they were
 added.
 
 single server. That is, it will flush the servers in the order that they were
 added.
 

-
-------

 RETURN
 ------
 
 RETURN
 ------
 

-
-A value of type :type:`memcached_return_t` is returned 
+A value of type :type:`memcached_return_t` is returned

 On success that value will be `MEMCACHED_SUCCESS`.
 Use :type:`memcached_strerror` to translate this value to a printable string.
 
 On success that value will be `MEMCACHED_SUCCESS`.
 Use :type:`memcached_strerror` to translate this value to a printable string.
 

-
---------

 SEE ALSO
 --------
 
 SEE ALSO
 --------