Update some documentation

ratt-ru · May 24, 2020 · e30ece8 · e30ece8
1 parent c0edaab
commit e30ece8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,8 +4,9 @@
 
   - Fixed legend display bug
   - ``--gain-type`` argument is now optional
+  - Static and interactive files can be generated simultaneously by specifying both ``--plotname`` and ``--htmlname``
 
-
+ous
 **general**
 
   - Fixed bug in phase wrapping

diff --git a/docs/source/gains.rst b/docs/source/gains.rst
@@ -74,9 +74,9 @@ It is possible to generate PNG and SVG with ``ragavi-gains`` via two methods. Th
 
     export PATH=$PATH:/absolute/path/to/gecko
 
-With this setup, one can now supply to ``ragavi-gains`` a ``--plotname`` value, which will result in the generation of PNG/SVG files, depending on the file extension provided. If, for example the plotname provided is ``foo.png``, ``ragavi-gains`` will assume the desired output should be PNG. The same applies for SVG.
+With this setup, one can now supply to ``ragavi-gains`` a ``--plotname`` value, which will result in the generation of PNG/SVG files, depending on the file extension provided. If, for example, the plotname provided is ``foo.png``, ``ragavi-gains`` will assume the desired output should be PNG. The same applies for SVG. If both ``--plotname`` and ``--htmlname`` are provided, ``ragavi`` will generate both static (PNG) and interactive (HTML) outputs simulaneously.
 
-It is necessary to point out that by default, ``ragavi`` uses the canvas image backend for interactive plots, due to performance issues associated with SVG image backend as stated in the `docs`_.
+It is necessary to point out that by default, ``ragavi`` uses the canvas image backend for interactive plots, due to performance issues associated with SVG image backend as stated in the Bokeh `docs`_.
 The default plots generated are always in HTML format.