]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/rados/api: fix invalid RST syntax and don't sudo for vim
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 2 May 2022 03:14:05 +0000 (10:14 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 2 May 2022 04:50:52 +0000 (11:50 +0700)
Fix invalid syntax where "linenos:" was printed in the
final rendered documentation instead of being used as
formatting syntax.

There is no need to use sudo for editing a source file
so run vim without sudo.

Change the whole block to use bash prompt since it is
a command.

Also modify the preceding text to hopefully not bold it.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/rados/api/python.rst

index 00c04e83f97c06f9fc585a062ca94c77cb3c2312..df9c367498f8b431bfbecb4f8517a8b011adb98b 100644 (file)
@@ -20,10 +20,11 @@ perform object operations as a ``client.admin`` user.
 .. note:: To use the Ceph Python bindings, you must have access to a
    running Ceph cluster. To set one up quickly, see `Getting Started`_.
 
-First, create a Python source file for your Ceph client. ::
-   :linenos:
+First, create a Python source file for your Ceph client.
+
+.. prompt:: bash
 
-       sudo vim client.py
+       vim client.py
 
 
 Import the Module