From: Scott Kostyshak <skostysh@lyx.org>
Date: Tue, 19 Jul 2016 06:11:27 +0000 (-0400)
Subject: Improve documentation of LFUN_BUFFER_ZOOM_{IN,OUT}
X-Git-Tag: 2.3.0alpha1~1234
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=3826ff643433ad166c3402b146b3860ab5d6861e;p=features.git

Improve documentation of LFUN_BUFFER_ZOOM_{IN,OUT}

The default for ZOOM_OUT is -20 from a user perspective. That is,
the following are equivalent:

  buffer-zoom-out -20
  buffer-zoom-out

The reason for this is that the argument to ZOOM_OUT is treated the
exact same way as ZOOM_IN. The only way they differ is how the
default case is handled.

This commit also clarifies that (1) the argument may be positive or
negative and that (2) the argument is interpreted as percentage
points, not percent.
---

diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx
index f2cf36ffc7..7cc1775f6e 100644
--- a/lib/doc/LFUNs.lyx
+++ b/lib/doc/LFUNs.lyx
@@ -5908,7 +5908,7 @@ Syntax buffer-zoom-in [<ZOOM>]
 \end_layout
 
 \begin_layout Description
-Params <ZOOM>: The zoom in %, the default is 20.
+Params <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
 \end_layout
 
 \begin_layout Description
@@ -5928,7 +5928,7 @@ Syntax buffer-zoom-out [<ZOOM>]
 \end_layout
 
 \begin_layout Description
-Params <ZOOM>: The zoom in %, the default is 20.
+Params <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
 \end_layout
 
 \begin_layout Description
diff --git a/src/LyXAction.cpp b/src/LyXAction.cpp
index 24687c79f0..77864db8c1 100644
--- a/src/LyXAction.cpp
+++ b/src/LyXAction.cpp
@@ -3739,7 +3739,7 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
  * \li Action: Increases the zoom of the screen fonts.
  * \li Syntax: buffer-zoom-in [<ZOOM>]
- * \li Params: <ZOOM>: The zoom in %, the default is 20.
+ * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
  * \li Origin: vfr, 30 Mar 2009
  * \endvar
  */
@@ -3749,7 +3749,7 @@ void LyXAction::init()
  * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
  * \li Action: Decreases the zoom of the screen fonts.
  * \li Syntax: buffer-zoom-out [<ZOOM>]
- * \li Params: <ZOOM>: The zoom in %, the default is 20.
+ * \li Params: <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
  * \li Origin: vfr, 30 Mar 2009
  * \endvar
  */