ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-06-18 15:28:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

some doc improvements

Browse Source
This commit is contained in:
Jean-Paul Calderone
2023-01-12 15:37:07 -05:00
parent 2490f0f58a
commit 2d23e2e640
2 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/allmydata/client.py
View File

@ -1102,16 +1102,18 @@ class _Client(node.Node, pollmixin.PollMixin):
:param version: If given, the mutable file format for the new object
(otherwise a format will be chosen automatically).
:param unique_keypair: **Warning** This valuely independently
determines the identity of the mutable object to create. There
cannot be two different mutable objects that share a keypair.
They will merge into one object (with undefined contents).
:param unique_keypair: **Warning** This value independently determines
the identity of the mutable object to create. There cannot be two
different mutable objects that share a keypair. They will merge
into one object (with undefined contents).
It is not common to pass a non-None value for this parameter. If
None is given then a new random keypair will be generated.
It is common to pass a None value (or not pass a valuye) for this
parameter. In these cases, a new random keypair will be
generated.
If non-None, the given public/private keypair will be used for the
new object.
new object. The expected use-case is for implementing compliance
tests.
:return: A Deferred which will fire with a representation of the new
mutable object after it has been uploaded.