From 0c6c3e52116a09203525793c3b2babbd3f13cc8e Mon Sep 17 00:00:00 2001
From: marioalexis <mario.passaglia@gmail.com>
Date: Tue, 7 Jun 2022 02:54:03 -0300
Subject: [PATCH] Base: Improve docstrings in PersistencePy.xml

---
 src/Base/PersistencePy.xml | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

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 @@
     <Documentation>
       <Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
       <DeveloperDocu>This is the Persistence class</DeveloperDocu>
-      <UserDocu>This is a persistence class</UserDocu>
+      <UserDocu>Base.Persistence class.\n
+Class to dump and restore the content of an object.</UserDocu>
     </Documentation>
     <Attribute Name="Content" ReadOnly="true">
       <Documentation>
-        <UserDocu>Content of the object in XML representation</UserDocu>
+        <UserDocu>Content of the object in XML representation.</UserDocu>
       </Documentation>
       <Parameter Name="Content" Type="String" />
     </Attribute>
     <Attribute Name="MemSize" ReadOnly="true">
       <Documentation>
-        <UserDocu>Memory size of the object in byte</UserDocu>
+        <UserDocu>Memory size of the object in bytes.</UserDocu>
       </Documentation>
       <Parameter Name="MemSize" Type="Int"/>
     </Attribute>
     <Methode Name="dumpContent" Keyword="true" Const="true">
             <Documentation>
-                <UserDocu>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)
-                </UserDocu>
+                <UserDocu>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.</UserDocu>
             </Documentation>
     </Methode>
     <Methode Name="restoreContent">
             <Documentation>
-                <UserDocu>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
-                </UserDocu>
+                <UserDocu>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.</UserDocu>
             </Documentation>
     </Methode>
   </PythonExport>