Some changes to documentation

FAIRsharing · Nov 2, 2018 · 1a342d9 · 1a342d9
1 parent 142468e
commit 1a342d9
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 14 deletions.
diff --git a/semDiff/compareEntities.py b/semDiff/compareEntities.py
@@ -4,10 +4,10 @@
 
 
 class EntityCoverage:
-    """
-     A class that compute the overlap between two JSON schemas semantic values taken from context
+    """ A class that compute the overlap between two JSON schemas semantic values taken from context
      files. This operation is not commutative. Thus, to find out if the schema/context pairs are
      equivalent, we need to run both semDiff(s_a, c_a, s_b, c_b) and semDiff(s_b, c_b, s_a, c_a)
+
      :param schema_a: the content of the first schema
      :param context_a: the context content bound to the first schema
      :param schema_b: the content of the second schema
@@ -37,9 +37,9 @@ def __init__(self, schema_a, context_a, schema_b, context_b):
         }
 
     def __build_context_dict(self, schema_input):
-        """
-        A private method that associate each field in a schema to it's semantic value in the
+        """A private method that associate each field in a schema to it's semantic value in the
         context and reverse the result
+
         :param schema_input:
         :return sorted_values: a dictionary of semantic values and their corresponding field
         :return ignored_fields: a list of fields that were ignored due to having no semantic value
@@ -85,9 +85,9 @@ def __build_context_dict(self, schema_input):
 
     @staticmethod
     def __process_field(field_name, field_value, context, comparator):
-        """
-        Private method that catches a given field semantic value from the given context and adds it
+        """Private method that catches a given field semantic value from the given context and adds it
         to the output
+
         :param field_name: the name of the given field
         :param field_value: the value of the given field
         :param context: the context from which to retrieve the semantic value
@@ -117,8 +117,8 @@ def __process_field(field_name, field_value, context, comparator):
 
     @staticmethod
     def __compute_context_coverage(context1, context2):
-        """
-        Private method that compares the fields from the two schemas based on their semantic values
+        """Private method that compares the fields from the two schemas based on their semantic values
+
         :param context1: the final output of __build_context_dict() for the first schema
         :param context2: the final output of __build_context_dict() for the second schema
         :return local_overlap_value: a namedtuple containing relative and absolute coverage

diff --git a/source/index.rst b/source/index.rst
@@ -10,10 +10,10 @@ Welcome to jsonldschema's documentation!
    :maxdepth: 2
    :numbered:
 
-   cedarUtilities
    semanticComparator
    schemaUtilities
    validationUtilities
+   cedarUtilities
 
 
 Indices and tables

diff --git a/source/schemaUtilities.rst b/source/schemaUtilities.rst
@@ -1,4 +1,4 @@
-UTILITIES FOR PREPARING FUNCTIONS INPUT
+Utilities  FOR PREPARING FUNCTIONS INPUT
 =======================================
 
 .. automodule:: schema2context

diff --git a/source/semanticComparator.rst b/source/semanticComparator.rst
@@ -1,5 +1,5 @@
-UTILITIES FOR SEMANTIC COMPARISON
-=================================
+Utilities for semantic comparison of JSON-LD-schemas
+====================================================
 
 .. automodule:: compareEntities
     :members:

diff --git a/source/validationUtilities.rst b/source/validationUtilities.rst
@@ -1,5 +1,5 @@
-UTILITIES TO VALIDATE SCHEMA AND INSTANCES
-==========================================
+Utilities to validate JSON-schemas and instances
+================================================
 
 .. automodule:: jsonschema_validator
     :members: