Changeset 1858 for trunk/python/env.py

Timestamp:

08/05/10 11:46:40 (14 years ago)

Author:

Malte Marquarding

Message:

Adde more API documentation

File:

• trunk/python/env.py (modified) (4 diffs)

trunk/python/env.py

@@ +1 @@
+"""This module has various functions for environment specific setings.
+"""
 __all__ = ["is_casapy", "is_ipython", "setup_env", "get_revision"]
 
@@ -7 +9 @@
 
 def is_casapy():
+    """Are we running inside casapy?"""
     try:
         from taskinit import casalog
@@ -14 +17 @@
 
 def is_ipython():
+    """Are we running inside IPython?"""
     return 'IPython' in sys.modules.keys()
 
 def setup_env():
+    """Set-up environment variables for casa and initialise ~/.asap on first
+    use.
+    """
     # Set up CASAPATH and first time use of asap i.e. ~/.asap/*
     plf = None
@@ -59 +66 @@
 
 def get_revision():
+    """Get the revision of the software. Only useful within casapy."""
     if not is_casapy:
         return ' unknown '