Doc tweaks, version bump

inducer · Jul 7, 2014 · b785c15 · b785c15
1 parent 7f08a8f
commit b785c15
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -78,8 +78,8 @@ Contents
 
     installation
     tri-tet
-    geometry
     gmsh
+    geometry
     faq
 
 MeshPy has its own `web page <http://mathema.tician.de/software/meshpy>`_, where you

diff --git a/meshpy/__init__.py b/meshpy/__init__.py
@@ -1 +1 @@
-version = "2013.1.2"
+version = "2014.1"
diff --git a/meshpy/gmsh.py b/meshpy/gmsh.py
@@ -33,12 +33,18 @@ def error_clean_up(self):
 
 
 class LiteralSource(object):
+    """
+    .. versionadded:: 2014.1
+    """
     def __init__(self, source, extension):
         self.source = source
         self.extension = extension
 
 
 class FileSource(object):
+    """
+    .. versionadded:: 2014.1
+    """
     def __init__(self, filename):
         self.filename = filename
 

diff --git a/meshpy/gmsh_reader.py b/meshpy/gmsh_reader.py
@@ -425,6 +425,7 @@ def generate_gmsh(receiver, source, dimensions, order=None, other_options=[],
             extension="geo", gmsh_executable="gmsh", force_dimension=None):
     """Run gmsh and feed the output to *receiver*.
 
+    :arg source: an instance of :class:`LiteralSource` or :class:`FileSource`
     :param receiver: Implements the :class:`GmshMeshReceiverBase` interface.
     """
     from meshpy.gmsh import GmshRunner
@@ -444,6 +445,7 @@ def generate_gmsh(receiver, source, dimensions, order=None, other_options=[],
 
 def parse_gmsh(receiver, line_iterable, force_dimension=None):
     """
+    :arg source: an instance of :class:`LiteralSource` or :class:`FileSource`
     :arg receiver: This object will be fed the entities encountered in reading the
         GMSH file. See :class:`GmshMeshReceiverBase` for the interface this
         object needs to conform to.