Changeset ecc050 for doc/userguide/userguide.xml

Timestamp:

May 19, 2021, 7:06:29 PM (4 years ago)

Author:

Frederik Heber <frederik.heber@…>

Branches:

Candidate_v1.7.0, stable

Children:

923ce2

Parents:

8c9cce

git-author:

Frederik Heber <frederik.heber@…> (04/24/19 21:29:22)

git-committer:

Frederik Heber <frederik.heber@…> (05/19/21 19:06:29)

Message:

pyMoleCuilder's wait() has return value.

• tells whether actions have been executed successfully or not.
• DOCU: updated docu

File:

• doc/userguide/userguide.xml (modified) (2 diffs)

doc/userguide/userguide.xml

@@ -1603 +1603 @@
           <programlisting>... change-box &quot;20,0,20,0,0,20&quot;</programlisting>
           <para>As the domain matrix is symmetric, six values suffice to fully
-          specify it. We have to give the six components of the lower triangle           matrix. Here, we change the box to a cuboid of equal edge length of
-          20.<warning>
-              <para>In case of the python interface an upper triangle matrix is given. Hence, the above would read &quot;20,0,0,20,0,20&quot;.</para>
-            </warning></para>
+          specify it. We have to give the six components of the lower triangle
+          matrix. Here, we change the box to a cuboid of equal edge length of
+          20.
+          <warning>
+            <para>In case of the python interface an upper triangle matrix is given. Hence, the above would read &quot;20,0,0,20,0,20&quot;.</para>
+          </warning></para>
         </section>
         <section xml:id="domain.bound-in-box">
@@ -3244 +3246 @@
       <programlisting>
          mol.MoleculeLoad("...")
-         mol.wait()
+         status = mol.wait()
       </programlisting>
-      <para>This will continue first after the molecule has been fully loaded.
-      </para>
+      <para>This will continue first only after the molecule has been fully 
+      loaded. Moreover, wait returns whether the actions contained executed
+      succesfully.</para>
       <warning>These wait()s will have no effect if the python script is loaded
       via the "load-session" command inside a User Interface (command-line,