diff --git a/src/Base/PersistencePy.xml b/src/Base/PersistencePy.xml index 1be978748b..581cbaaeca 100644 --- a/src/Base/PersistencePy.xml +++ b/src/Base/PersistencePy.xml @@ -12,35 +12,35 @@ This is the Persistence class - This is a persistence class + Base.Persistence class.\n +Class to dump and restore the content of an object. - Content of the object in XML representation + Content of the object in XML representation. - Memory size of the object in byte + Memory size of the object in bytes. - Dumps the content of the object, both the XML representation as well as the additional datafiles -required, into a byte representation. It will be returned as byte array. -dumpContent() -- returns a byte array with full content -dumpContent(Compression=1-9) -- Sets the data compression from 0 (no) to 9 (max) - + dumpContent(Compression=3) -> bytearray\n +Dumps the content of the object, both the XML representation and the additional +data files required, into a byte representation.\n +Compression : int\n Set the data compression level in the range [0,9]. Set to 0 for no compression. - Restore the content of the object from a byte representation as stored by \"dumpContent\". -It could be restored from any python object implementing the buffer protocol. -restoreContent(buffer) -- restores from the given byte array - + restoreContent(obj) -> None\n +Restore the content of the object from a byte representation as stored by `dumpContent`. +It could be restored from any Python object implementing the buffer protocol.\n +obj : buffer\n Object with buffer protocol support.