updated to the latest mmif-python, updated documentation formatting

clamsproject · Jul 29, 2024 · 5ed5876 · 5ed5876
1 parent 9c5e1bd
commit 5ed5876
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 21 deletions.
diff --git a/clams/app/__init__.py b/clams/app/__init__.py
@@ -31,6 +31,7 @@
     False
 ]
 
+
 class ClamsApp(ABC):
     """
     An abstract class to define API's for ClamsApps. A CLAMS app should inherit

diff --git a/clams/mmif_utils/rewind.py b/clams/mmif_utils/rewind.py
@@ -1,7 +1,9 @@
+"""
+This module provides a CLI to rewind a MMIF from a CLAMS pipeline.
+"""
 import argparse
 import sys
 import textwrap
-from pathlib import Path as P
 
 import mmif
 

diff --git a/clams/mmif_utils/source.py b/clams/mmif_utils/source.py
@@ -1,3 +1,6 @@
+"""
+This module provides a class for creating a "source" MMIF JSON object.
+"""
 import argparse
 import itertools
 import json

diff --git a/documentation/autodoc/clams.app.rst b/documentation/autodoc/clams.app.rst
@@ -1,8 +1,7 @@
 clams.app package
-===================
+==================
 
-Module contents
----------------
+Core package providing classes for representing CLAMS apps.
 
 .. automodule:: clams.app
    :members:

diff --git a/documentation/autodoc/clams.appmetadata.rst b/documentation/autodoc/clams.appmetadata.rst
@@ -1,8 +1,7 @@
 clams.appmetadata package
 =========================
 
-Module contents
----------------
+Package providing classes for representing metadata of CLAMS apps.
 
 .. autoclass:: clams.appmetadata.AppMetadata
    :members:

diff --git a/documentation/autodoc/clams.mmif_utils.rst b/documentation/autodoc/clams.mmif_utils.rst
@@ -0,0 +1,16 @@
+clams.mmif_utils package
+========================
+
+Package providing utility functions for working with MMIF data.
+
+``rewind`` module
+-----------------
+
+.. automodule:: clams.mmif_utils.rewind
+   :members:
+
+``source`` module
+-----------------
+
+.. automodule:: clams.mmif_utils.source
+   :members:
diff --git a/documentation/autodoc/clams.restify.rst b/documentation/autodoc/clams.restify.rst
@@ -1,8 +1,7 @@
 clams.restify package
 =====================
 
-Module contents
----------------
+Package providing wrapper class for running a CLAMS app as a HTTP app.
 
 .. automodule:: clams.restify
    :members:

diff --git a/documentation/autodoc/clams.source.rst b/documentation/autodoc/clams.source.rst
diff --git a/documentation/modules.rst b/documentation/modules.rst
@@ -5,7 +5,7 @@ API documentation
 .. toctree::
    :maxdepth: 4
 
-   autodoc/clams.restify
    autodoc/clams.app
-   autodoc/clams.source
    autodoc/clams.appmetadata
+   autodoc/clams.restify
+   autodoc/clams.mmif_utils
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
-mmif-python==1.0.18
+mmif-python==1.0.19
 
 Flask>=2
 Flask-RESTful>=0.3.9
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,6 +31,7 @@ @@
         False
     ]
     class ClamsApp(ABC):
         """
         An abstract class to define API's for ClamsApps. A CLAMS app should inherit
@@ Expand Down @@