renamed doc to docs and more documentation

README.rst

@@ -170,7 +170,7 @@ AArch64 markers
 ^^^^^^^^^^^^^^^
 **Byte markers**
 
-.. code-block:: asm
+.. code-block:: arm
 
       mov      x1, #111        // OSACA START
       .byte    213,3,32,31     // OSACA START
@@ -182,7 +182,7 @@ AArch64 markers
     
 **Comment line markers**
 
-.. code-block:: asm
+.. code-block:: arm
   
       // OSACA-BEGIN
     .loop:

osaca/frontend.py

@@ -37,7 +37,8 @@ class Frontend(object):
         """
         Checks if instruction form is a comment-only line.
 
-        :param instruction_form: instruction form as dict
+        :param instruction_form: instruction form to check
+        :type instruction_form: `dict`
         :returns: `True` if comment line, `False` otherwise
         """
         return instruction_form['comment'] is not None and instruction_form['instruction'] is None
@@ -272,6 +273,7 @@ class Frontend(object):
     ####################
 
     def _missing_instruction_error(self, amount):
+        """Returns the warning for if any instruction form in the analysis is missing."""
         s = (
             '------------------ WARNING: The performance data for {} instructions is missing.'
             '------------------\n'

osaca/osaca.py

@@ -51,6 +51,8 @@ def create_parser(parser=None):
     """
     Return argparse parser.
 
+    :param parser: Existing parser object to add the arguments, defaults to `None`
+    :type parser: :class:`~Argparse.ArgumentParser`
     :returns: The newly created :class:`~Argparse.ArgumentParser` object.
     """
     # Create parser
@@ -156,6 +158,8 @@ def import_data(benchmark_type, arch, filepath, output_file=sys.stdout):
     :type arch: str
     :param filepath: filepath of the output file"
     :type filepath: str
+    :param output_file: output stream specifying where to write output, defaults to :class:`sys.stdout`
+    :type output_file: stream
     """
     if benchmark_type.lower() == 'ibench':
         import_benchmark_output(arch, 'ibench', filepath, output=output_file)