Add debug mode (in settings). Use logging in debug mode only. Update …

…docs.

.matyan.ini

@@ -22,3 +22,6 @@ exact: more
        commit
 prefix: more on
         continue on
+
+[Settings]
+debug: true

CHANGELOG.rst

@@ -15,6 +15,16 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.4.3
+-----
+2019-12-26
+
+- Ensure correct order of releases.
+- Exclude unnecessary data from distribution.
+- Add Jupyter notebook examples.
+- Introduce debug mode (turned off by default). At the moment, logging is
+  used in debug mode only.
+
 0.4.2
 -----
 2019-12-25

README.rst

@@ -226,7 +226,7 @@ Sample configuration:
 
 Note, that placing ``.matyan.ini`` into the home root will make that
 configuration global for all projects. That however could be handy, since local
-``.matyan.ini`` files simply override the global ones. For example, you could
+``.matyan.ini`` files simply extend the global ones. For example, you could
 use global configuration for storing Jira credentials.
 
 .. code-block:: text
@@ -236,6 +236,8 @@ use global configuration for storing Jira credentials.
     username:user@domain.com
     token:abcd1234
 
+Note, however, that sections are copied over entirely.
+
 Tips and tricks
 ===============
 Write to file
@@ -277,9 +279,16 @@ Sometimes checking logs could be handy. ``Matyan`` logs are stored in the
 directory, from which you are running the ``generate-changelog`` (or any
 other ``Matyan``) command.
 
+Update your ``.matyan.ini`` configuration in the following way:
+
+.. code-block:: text
+
+    [Settings]
+    debug=true
+
 .. code-block:: sh
 
-    tail -f /path/to/your/matyan.log
+    tail -f /path/to/your/project/matyan.log
 
 If you want to modify current logging, use ``MATYAN_LOGGING_CONFIG``
 environment variable.

docs/changelog.rst

@@ -15,6 +15,16 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.4.3
+-----
+2019-12-26
+
+- Ensure correct order of releases.
+- Exclude unnecessary data from distribution.
+- Add Jupyter notebook examples.
+- Introduce debug mode (turned off by default). At the moment, logging is
+  used in debug mode only.
+
 0.4.2
 -----
 2019-12-25

docs/index.rst

@@ -226,7 +226,7 @@ Sample configuration:
 
 Note, that placing ``.matyan.ini`` into the home root will make that
 configuration global for all projects. That however could be handy, since local
-``.matyan.ini`` files simply override the global ones. For example, you could
+``.matyan.ini`` files simply extend the global ones. For example, you could
 use global configuration for storing Jira credentials.
 
 .. code-block:: text
@@ -236,6 +236,8 @@ use global configuration for storing Jira credentials.
     username:user@domain.com
     token:abcd1234
 
+Note, however, that sections are copied over entirely.
+
 Tips and tricks
 ===============
 Write to file
@@ -277,9 +279,16 @@ Sometimes checking logs could be handy. ``Matyan`` logs are stored in the
 directory, from which you are running the ``generate-changelog`` (or any
 other ``Matyan``) command.
 
+Update your ``.matyan.ini`` configuration in the following way:
+
+.. code-block:: text
+
+    [Settings]
+    debug=true
+
 .. code-block:: sh
 
-    tail -f /path/to/your/matyan.log
+    tail -f /path/to/your/project/matyan.log
 
 If you want to modify current logging, use ``MATYAN_LOGGING_CONFIG``
 environment variable.