Apply suggestions from code review

Co-Authored-By: Achilleas Koutsou <[email protected]>

Author: mpsonntag

odml/base.py

@@ -484,7 +484,7 @@ def _get_section_by_path(self, path):
 
     def find(self, key=None, type=None, findAll=False, include_subtype=False):
         """
-        Return the first subsection named *key* of type *type*.
+        Returns the first subsection named *key* of type *type*.
 
         :param key: string to search against an odML objects name.
         :param type: type of an odML object.
@@ -619,7 +619,7 @@ def clean(self):
 
     def clone(self, children=True, keep_id=False):
         """
-        Clone this object recursively allowing to copy it independently
+        Clones this object recursively allowing to copy it independently
         to another document.
         """
         from odml.section import BaseSection

odml/dtypes.py

@@ -123,7 +123,7 @@ def valid_type(dtype):
 
 def get(string, dtype=None):
     """
-    Convert *string* to the corresponding *dtype*.
+    Converts *string* to the corresponding *dtype*.
     The appropriate function is derived from the provided dtype.
     If no dtype is provided, the string conversion function is used by default.
 
@@ -142,7 +142,7 @@ def get(string, dtype=None):
 
 def set(value, dtype=None):
     """
-    Serialize a *value* of type *dtype* to a unicode string.
+    Serializes a *value* of type *dtype* to a unicode string.
     The appropriate function is derived from the provided dtype.
 
     :param value: odml specific value to be converted into a string.
@@ -320,7 +320,7 @@ def boolean_get(string):
 
 def tuple_get(string, count=None):
     """
-    Parse a tuple string like "(1024;768)" and return a list of strings with the
+    Parses a tuple string like "(1024;768)" and return a list of strings with the
     individual tuple elements.
 
     :param string: string to be parsed into odML style tuples.
@@ -339,7 +339,7 @@ def tuple_get(string, count=None):
 
 def tuple_set(value):
     """
-    Serialize odml style tuples to a string representation.
+    Serializes odml style tuples to a string representation.
 
     :param value: odml style tuple values.
     :return: string.

odml/property.py

@@ -195,7 +195,7 @@ def dtype(self, new_type):
     @property
     def parent(self):
         """
-        Returns the Section containing this Property.
+        The Section containing this Property.
         """
         return self._parent
 

odml/rdf/fuzzy_finder.py

@@ -19,7 +19,7 @@ def __init__(self, graph=None, q_params=None):
 
     def find(self, mode="fuzzy", graph=None, q_str=None, q_params=None):
         """
-        Apply set of queries to the graph and returns info
+        Applies set of queries to the graph and returns info
         that was retrieved from queries.
 
         :param mode:     define the type of parser which will be used for parsing

odml/rdf/query_creator.py

@@ -39,7 +39,7 @@ def __init__(self, q_dict=None):
     @abstractmethod
     def get_query(self, q_str, q_parser):
         """
-        Construct a SPARQL query from an input string.
+        Constructs a SPARQL query from an input string.
 
         :param q_str: input string.
         :param q_parser: parser to use on the input string.
@@ -65,7 +65,7 @@ def __init__(self):
     @abstractmethod
     def parse_query_string(self, q_str):
         """
-        Parse an input string and return a dictionary consumable by a QueryCreator.
+        Parses an input string and return a dictionary consumable by a QueryCreator.
         """
         pass
 

odml/section.py

@@ -134,7 +134,7 @@ def new_id(self, oid=None):
     @property
     def name(self):
         """
-        Returns the name of the Section.
+        The name of the Section.
         """
         return self._name
 
@@ -195,7 +195,7 @@ def include(self, new_value):
     @property
     def link(self):
         """
-        Specifies a softlink, i.e. a path within the document.
+        A softlink, i.e. a path within the document.
         When the merge()-method is called, the link will be resolved creating
         according copies of the section referenced by the link attribute.
         When the unmerge() method is called (happens when running clean())
@@ -236,7 +236,7 @@ def link(self, new_value):
     @property
     def definition(self):
         """
-        Returns the definition of the Section.
+        The definition of the Section.
         """
         return self._definition
 
@@ -292,7 +292,7 @@ def sections(self):
     @property
     def parent(self):
         """
-        Returns the parent Section, Document or None.
+        The parent Section, Document or None.
         """
         return self._parent
 
@@ -350,7 +350,7 @@ def get_terminology_equivalent(self):
 
     def get_merged_equivalent(self):
         """
-        Return the merged object or None.
+        Returns the merged object or None.
         """
         return self._merged
 
@@ -659,7 +659,7 @@ def create_property(self, name, value=None, dtype=None, oid=None):
 
     def pprint(self, indent=2, max_depth=1, max_length=80, current_depth=0):
         """
-        Pretty print method to visualize Section-Property trees.
+        Pretty prints Section-Property trees for nicer visualization.
 
         :param indent: number of leading spaces for every child Section or Property.
         :param max_depth: number of maximum child section layers to traverse and print.
@@ -687,7 +687,7 @@ def pprint(self, indent=2, max_depth=1, max_length=80, current_depth=0):
 
     def export_leaf(self):
         """
-        Export only the path from this section to the root.
+        Exports only the path from this section to the root.
         Include all properties for all sections, but no other subsections.
 
         :returns: cloned odml tree to the root of the current document.

odml/terminology.py

@@ -26,7 +26,7 @@
 
 def cache_load(url):
     """
-    Load the url and store it in a temporary cache directory
+    Loads the url and store it in a temporary cache directory
     subsequent requests for this url will use the cached version.
 
     :param url: URL from where to load an odML terminology file from.
@@ -67,7 +67,7 @@ class Terminologies(dict):
 
     def load(self, url):
         """
-        Load and cache an odML XML file from a URL.
+        Loads and caches an odML XML file from a URL.
 
         :param url: location of an odML XML file.
         :return: The odML document loaded from url.
@@ -108,7 +108,7 @@ def _load(self, url):
 
     def deferred_load(self, url):
         """
-        Start a background thread to load an odML XML file from a URL.
+        Starts a background thread to load an odML XML file from a URL.
 
         :param url: location of an odML XML file.
         """

odml/tools/converters/format_converter.py

@@ -54,7 +54,7 @@ class FormatConverter(object):
     @classmethod
     def convert(cls, args=None):
         """
-        Enable usage of the argparse for calling convert_dir(...)
+        Enables usage of the argparse for calling convert_dir(...)
 
         Usage:
         python -m <in_dir> <odml_out_format> [-out <out_dir>] [-r]
@@ -131,7 +131,7 @@ def convert_dir(cls, input_dir, output_dir, parse_subdirs, res_format):
     @classmethod
     def _convert_file(cls, input_path, output_path, res_format):
         """
-        Convert a file from given input_path to res_format. Will raise a ValueError
+        Converts a file from given input_path to res_format. Will raise a ValueError
         if the provided output format (res_format) is not supported.
 
         :param input_path: full path including file name of the file to be converted.

odml/tools/converters/version_converter.py

@@ -276,7 +276,7 @@ def _handle_repository(self, element):
 
     def _handle_properties(self, root):
         """
-        Method removes all property elements w/o name attribute, converts Value
+        Removes all property elements without name attribute, converts Value
         elements from v1.0 to v1.1 style and removes unsupported Property elements.
 
         :param root: lxml.ElementTree containing a v1.0 odML property list.

odml/tools/dumper.py

@@ -7,7 +7,7 @@
 
 def get_props(obj, props):
     """
-    get_props retrieves the values of a list of provided properties
+    Retrieves the values of a list of provided properties
     from an object and returns all values as a concatenated string.
 
     :param obj: odml object from which to retrieve specific property values.
@@ -29,7 +29,7 @@ def get_props(obj, props):
 
 def dump_property(prop, indent=1):
     """
-    dump_property prints the content of an odml.Property.
+    Prints the content of an odml.Property.
 
     :param prop: odml.Property
     :param indent: number of prepended whitespaces. Default is 1.
@@ -42,7 +42,7 @@ def dump_property(prop, indent=1):
 
 def dump_section(section, indent=1):
     """
-    dump_section prints the content of an odml.Section including any subsections
+    Prints the content of an odml.Section including any subsections
     and odml.Properties.
 
     :param section: odml.Section
@@ -64,7 +64,7 @@ def dump_section(section, indent=1):
 
 def dump_doc(doc):
     """
-    dump_doc prints the content of an odml.Document including any subsections
+    Prints the content of an odml.Document including any subsections
     and odml.Properties.
 
     :param doc: odml.Section