fix: doc: even more docstring and readme/rst doc cleanup

Signed-off-by: Stephen L Arnold <[email protected]>

README.rst

@@ -212,7 +212,7 @@ PyGObject_.
                They have been modified to check an environment variable
                and output a summary CSV format.
 
-Install either ``onelineday.py`` or ``totals.py`` as shown above. depending
+Install either ``onelineday.py`` or ``totals.py`` as shown above, depending
 on preferred tag format:
 
 onelineday
@@ -224,7 +224,9 @@ totals
 
 Set the extension script in the config file with the following key, using
 either "onelineday" or "totals" for the value. Similarly set the job-tag
-separator if needed::
+separator if needed:
+
+.. code-block:: yaml
 
   extension_script: onelineday
   jtag_separator: ";"

docs/source/conf.py

@@ -23,7 +23,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'timew-status-indicator'
+project = 'timew-addons'
 year = datetime.now().year
 copyright = f"{year}, Stephen L Arnold"
 author = 'Stephen L Arnold'
@@ -81,7 +81,7 @@
 
 pdf_documents = [
     #('filename', u'output filename', 'Title', 'author(s)'),
-    ('index', u'timew-status-indicator', u'Timew Addons', u"Stephen L Arnold"),
+    ('index', u'timew_status', u'Timew Addons', u"Stephen L Arnold"),
 ]
 
 # A comma-separated list of custom stylesheets. Example:

docs/source/index.rst

@@ -3,8 +3,8 @@ Documentation for timew-addons
 
 The primary timewarrior_ addon bits included here are written in Python_:
 
-* a pygobject_ appindicator GUI
-* some report extesnsions for timewarrior using timew-report_
+* ``timew-status-indicator`` - a pygobject_ appindicator GUI
+* related report extesnsions for timewarrior using timew-report_
 
 .. _Python: https://docs.python.org/3/contents.html
 .. _pygobject: https://pygobject.gnome.org/index.html

src/timew_status/utils.py

@@ -28,7 +28,7 @@
 def get_config(file_encoding='utf-8'):
     """
     Load configuration file and munchify the data. If local file is not
-    found in current directory, the default will be loaded.  Return a
+    found in config directory, the default will be loaded.  Return a
     Munch cfg obj and corresponding Path obj.
 
     :param file_encoding: file encoding of config file