document __version__ module member and version check

2021-02-09 12:29:14 -05:00
parent 65affd6f12
commit 653c296246
3 changed files with 30 additions and 2 deletions
--- a/python/lammps/init.py
+++ b/python/lammps/init.py
@ -1,3 +1,13 @@
+"""
+LAMMPS module global members:
+
+.. data:: __version__
+
+   Numerical representation of the LAMMPS version this
+   module was taken from.  Has the same format as the
+   result of :py:func:`lammps.version`.
+"""
+
 from .constants import *
 from .core import *
 from .data import *