yade-dev team mailing list archive
-
yade-dev team
-
Mailing list archive
-
Message #12067
[Branch ~yade-pkg/yade/git-trunk] Rev 3667: Doc of sphSph attribute of plotDirections precized
------------------------------------------------------------
revno: 3667
committer: jduriez <jerome.duriez@xxxxxxxxxxx>
timestamp: Tue 2015-06-02 17:32:38 -0600
message:
Doc of sphSph attribute of plotDirections precized
modified:
py/utils.py
--
lp:yade
https://code.launchpad.net/~yade-pkg/yade/git-trunk
Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-pkg/yade/git-trunk/+edit-subscription
=== modified file 'py/utils.py'
--- py/utils.py 2015-04-24 15:54:07 +0000
+++ py/utils.py 2015-06-02 23:32:38 +0000
@@ -534,7 +534,7 @@
def plotDirections(aabb=(),mask=0,bins=20,numHist=True,noShow=False,sphSph=False):
"""Plot 3 histograms for distribution of interaction directions, in yz,xz and xy planes and
- (optional but default) histogram of number of interactions per body. If sphSph only sphere-sphere interactions are considered.
+ (optional but default) histogram of number of interactions per body. If sphSph only sphere-sphere interactions are considered for the 3 directions histograms.
:returns: If *noShow* is ``False``, displays the figure and returns nothing. If *noShow*, the figure object is returned without being displayed (works the same way as :yref:`yade.plot.plot`).
"""