Merge pull request #301 from clamsproject/develop

releasing 1.0.19

Author: keighrim

documentation/autodoc/mmif.serialize.rst

@@ -1,31 +1,33 @@
-mmif.serialize module
-=====================
+mmif.serialize package
+======================
 
-mmif.serialize.model module
+Core package to provide serialization and deserialization of MMIF format. 
+
+``model`` module
 ---------------------------
 
 .. automodule:: mmif.serialize.model
    :members:
    :undoc-members:
    :show-inheritance:
 
-mmif.serialize.mmif module
+``mmif`` module
 --------------------------
 
 .. automodule:: mmif.serialize.mmif
    :members:
    :undoc-members:
    :show-inheritance:
 
-mmif.serialize.view module
+``view`` module
 --------------------------
 
 .. automodule:: mmif.serialize.view
    :members:
    :undoc-members:
    :show-inheritance:
 
-mmif.serialize.annotation module
+``annotation`` module
 --------------------------------
 
 .. automodule:: mmif.serialize.annotation

documentation/autodoc/mmif.utils.rst

@@ -1,18 +1,39 @@
-mmif.utils module
-=================
+mmif.utils package
+==================
 
-mmif.utils.video_document_helper module
+Package containing utility modules for handling different types of source 
+documents, and general implementation of common data structures and 
+algorithms.
+
+``video_document_helper`` module
 ----------------------------------------
 
 .. automodule:: mmif.utils.video_document_helper
    :members:
    :undoc-members:
    :show-inheritance:
 
-mmif.utils.sequence_helper module
+``text_document_helper`` module
+---------------------------------
+
+.. automodule:: mmif.utils.sequence_helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+``sequence_helper`` module
 ---------------------------------
 
 .. automodule:: mmif.utils.sequence_helper
    :members:
    :undoc-members:
    :show-inheritance:
+
+``sequence_helper`` module
+---------------------------------
+
+.. automodule:: mmif.utils.sequence_helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

documentation/autodoc/mmif.vocabulary.rst

@@ -1,18 +1,28 @@
 mmif.vocabulary module
 ======================
 
-mmif.vocabulary.annotation\_types module
-----------------------------------------
+Module contains Enum-like classes for CLAMS vocabulary.
 
-.. automodule:: mmif.vocabulary.annotation_types
+.. autoclass:: mmif.vocabulary.ThingTypesBase
+   :show-inheritance:
+.. autoclass:: mmif.vocabulary.ThingType
    :members:
    :undoc-members:
    :show-inheritance:
 
-mmif.vocabulary.document\_types module
---------------------------------------
+.. autoclass:: mmif.vocabulary.ClamsTypesBase
+   :show-inheritance:
+.. autoclass:: mmif.vocabulary.AnnotationTypesBase
+   :show-inheritance:
+.. autoclass:: mmif.vocabulary.DocumentTypesBase
+   :show-inheritance:
+
+.. autoclass:: mmif.vocabulary.AnnotationTypes
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-.. automodule:: mmif.vocabulary.document_types
+.. autoclass:: mmif.vocabulary.DocumentTypes
    :members:
    :undoc-members:
    :show-inheritance:

mmif/serialize/mmif.py

@@ -120,7 +120,7 @@ def get_last_contentful_view(self) -> Optional[View]:
         Returns the last view that is contentful, i.e., has no error or warning .
         """
         for view in reversed(self._items.values()):
-            if 'error' not in view.metadata and 'warning' not in view.metadata:
+            if 'error' not in view.metadata and 'warnings' not in view.metadata:
                 return view
 
     def get_last_view(self) -> Optional[View]:

mmif/utils/__init__.py

@@ -1 +0,0 @@
-from mmif.utils import video_document_helper