Correct command line usage documentation

yorgath · Jan 23, 2021 · 1f036a4 · 1f036a4
1 parent 01c3072
commit 1f036a4
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 4 deletions.
diff --git a/docs/cmd.rst b/docs/cmd.rst
@@ -12,7 +12,11 @@ enter the following command:
 
 This will create a ``diagram.svg`` file in the same directory.  If you
 wish to create a file with a different name or in a different
-directory, pass the path as a second argument.
+directory, use the ``-o`` switch like this:
+
+.. code-block:: console
+
+   $ python -m orthogram diagram.yaml -o images/something.svg
 
 The program creates Scalable Vector Graphics (SVG) files.  Use your
 web browser to view the drawing.  Use `Inkscape`_ to convert it to PNG

diff --git a/docs/conf.py b/docs/conf.py
@@ -22,7 +22,7 @@
 author = 'Georgios Athanasiou'
 
 # The full version, including alpha/beta/rc tags
-release = '0.4.1'
+release = '0.4.2'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/release.rst b/docs/release.rst
@@ -98,3 +98,9 @@ Release history
 * No code changes.
 * Updated depedencies.
 * Documentation fixes.
+
+0.4.2 (2021-01-23)
+------------------
+
+* No code changes.
+* Corrected command line usage documentation.
diff --git a/orthogram/__init__.py b/orthogram/__init__.py
@@ -1,4 +1,4 @@
-__version__ = '0.4.1'
+__version__ = '0.4.2'
 
 from .build import Builder
 from .diagram import DiagramDef

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "orthogram"
-version = "0.4.1"
+version = "0.4.2"
 description = "Draw block diagrams."
 license = "GPL-3.0-or-later"
 authors = ["Georgios Athanasiou <yorgath@gmail.com>"]