Skip to content

Commit

Permalink
kvs: add rst format to inline docs
Browse files Browse the repository at this point in the history
Problem: on the web version of the docs, which are
auto-generated, multiple lines of python appear on
the same line, and are formatted weirdly.

Add rst format to the inline docs.
  • Loading branch information
wihobbs committed Dec 26, 2024
1 parent 59cbf5e commit 0ce53e1
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions src/bindings/python/flux/kvs.py
Original file line number Diff line number Diff line change
Expand Up @@ -385,8 +385,10 @@ class KVSTxn:
Can be used as a context manager and commits will be handled at
exit. e.g.
with KVSTxn(handle, "basedirectory") as kt:
kt.put("a", 1)
.. code-block::
with KVSTxn(handle, "basedirectory") as kt:
kt.put("a", 1)
Args:
flux_handle: A Flux handle obtained from flux.Flux()
Expand Down Expand Up @@ -478,20 +480,24 @@ class KVSDir(WrapperPimpl, abc.MutableMapping):
KVS values can be read or written through this class's item accessor. e.g.
mydir = KVSDir(flux_handle)
print(mydir["mykey"])
.. code-block::
mydir = KVSDir(flux_handle)
print(mydir["mykey"])
mydir["newkey"] = "foo"
mydir.commit()
mydir["newkey"] = "foo"
mydir.commit()
Any KVS directories accessed through the item accessor will share
the same internal KVS transaction, so that only a single call to
commit() is necessary. e.g.
mydir = KVSDir(flux_handle)
subdir = mydir["subdir"]
subdir["anotherkey"] = "bar"
mydir.commit()
.. code-block::
mydir = KVSDir(flux_handle)
subdir = mydir["subdir"]
subdir["anotherkey"] = "bar"
mydir.commit()
Args:
flux_handle: A Flux handle obtained from flux.Flux()
Expand All @@ -506,7 +512,6 @@ class KVSDir(WrapperPimpl, abc.MutableMapping):
# pylint: disable=too-many-ancestors, too-many-public-methods

class InnerWrapper(Wrapper):

# pylint: disable=no-value-for-parameter
def __init__(self, flux_handle=None, path=".", handle=None, namespace=None):
dest = RAW.flux_kvsdir_destroy
Expand Down

0 comments on commit 0ce53e1

Please sign in to comment.