doc/radosgw: edit admin.rst "get user rate limit"

Edit "Get User Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>

diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index 88a7215fb1563501c6d814436b87681bd7c9f90d..8a4d1d1af84294f5a4cb15df4f08014940e0b173 100644 (file)
--- a/doc/radosgw/admin.rst
+++ b/doc/radosgw/admin.rst
@@ -671,18 +671,26 @@ specific rate limit attribute check is disabled.
 Get User Rate Limit
 -------------------
 
-Get the current configured rate limit parameters
-For example:: 
+The ``radosgw-admin ratelimit get`` command returns the current configured rate
+limit parameters.
 
-       radosgw-admin ratelimit get --ratelimit-scope=user --uid=<uid>
+The following is the general form of the command that returns the current
+configured limit parameters:  
 
-For example:: 
+.. prompt:: bash
 
-       radosgw-admin ratelimit get --ratelimit-scope=user --uid=johndoe
+   radosgw-admin ratelimit get --ratelimit-scope=user --uid=<uid>
 
+An example of using ``radosgw-admin ratelimit get`` to return the rate limit
+parameters might look like this: 
 
-A 0 value for num ops and / or num bytes means that the
-specific rate limit attribute check is disabled.
+.. prompt:: bash
+
+   radosgw-admin ratelimit get --ratelimit-scope=user --uid=johndoe
+
+A value of ``0`` assigned to ``--max-read-ops``, ``--max-read-bytes``,
+``--max-write-ops``, or ``--max-write-bytes`` disables the specified rate
+limit.  
 
 
 Enable/Disable User Rate Limit