Re: Minor addition to Speed Keys info node

[Kaushal Modi <kaushal.modi@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 4531 bytes --]

One minor iteration.. I think below reads with a better flow.. WDYT?

@kbd{M-x org-speed-command-help}, or @kbd{?} when cursor is at the
beginning of an Org headline, shows currently ..

Here's the full patch:

From 5886b6f7fe82858ae49b55d409d1baf20942dae8 Mon Sep 17 00:00:00 2001
From: Kaushal Modi <kaushal.modi@gmail.com>
Date: Wed, 7 Jun 2017 11:34:39 -0400
Subject: [PATCH] Mention org-speed-command-help in Speed Keys info node

* doc/org.texi (Speed keys): Mention org-speed-command-help.
---
 doc/org.texi | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 11c4ac4c72..04485b12e0 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -17028,14 +17028,16 @@ navigation, Speed Keys may come in handy on small
mobile devices that do not
 have full keyboards.  Speed Keys may also work on TTY devices known for
their
 problems when entering Emacs keychords.

-By default, Org has Speed Keys disabled.  To activate Speed Keys, configure
-the variable @code{org-use-speed-commands}.  To trigger a Speed Key, the
-cursor must be at the beginning of an Org headline, before any of the
stars.
-
-Org comes with a pre-defined list of Speed Keys; @kbd{?} shows currently
-active Speed Keys.  To add or modify Speed Keys, customize the variable,
-@code{org-speed-commands-user}.  For more details, see the variable's
-docstring.
+By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
+variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
+Speed Key, the cursor must be at the beginning of an Org headline, before
any
+of the stars.
+
+Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
+Keys, customize the variable, @code{org-speed-commands-user}.  For more
+details, see the variable's docstring.  With Speed Keys activated, @kbd{M-x
+org-speed-command-help}, or @kbd{?} when cursor is at the beginning of an
Org
+headline, shows currently active Speed Keys, including the user-defined
ones.


 @node Code evaluation security
-- 
2.13.0




On Wed, Jun 7, 2017 at 12:32 PM Kaushal Modi <kaushal.modi@gmail.com> wrote:

> On Wed, Jun 7, 2017 at 12:21 PM Nicolas Goaziou <mail@nicolasgoaziou.fr>
> wrote:
>
>> @kbd{?}---when cursor is at the beginning of an Org headline---shows
>> currently active Speed Keys,...
>>
>> > Org +headline) shows currently active Speed Keys, including the
>> > user-defined ones.
>>
>> Otherwise, LGTM.
>>
>
> Thanks. I was unaware of the --- syntax.
>
> Here's the updated patch:
>
> From 1a767fb97b680b9fef5d0fd301c9fcf951b705e3 Mon Sep 17 00:00:00 2001
> From: Kaushal Modi <kaushal.modi@gmail.com>
> Date: Wed, 7 Jun 2017 11:34:39 -0400
> Subject: [PATCH] Mention org-speed-command-help in Speed Keys info node
>
> * doc/org.texi (Speed keys): Mention org-speed-command-help.
> ---
>  doc/org.texi | 19 +++++++++++--------
>  1 file changed, 11 insertions(+), 8 deletions(-)
>
> diff --git a/doc/org.texi b/doc/org.texi
> index 11c4ac4c72..50a96333f2 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -17028,14 +17028,17 @@ navigation, Speed Keys may come in handy on
> small mobile devices that do not
>  have full keyboards.  Speed Keys may also work on TTY devices known for
> their
>  problems when entering Emacs keychords.
>
> -By default, Org has Speed Keys disabled.  To activate Speed Keys,
> configure
> -the variable @code{org-use-speed-commands}.  To trigger a Speed Key, the
> -cursor must be at the beginning of an Org headline, before any of the
> stars.
> -
> -Org comes with a pre-defined list of Speed Keys; @kbd{?} shows currently
> -active Speed Keys.  To add or modify Speed Keys, customize the variable,
> -@code{org-speed-commands-user}.  For more details, see the variable's
> -docstring.
> +By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
> +variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
> +Speed Key, the cursor must be at the beginning of an Org headline, before
> any
> +of the stars.
> +
> +Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
> +Keys, customize the variable, @code{org-speed-commands-user}.  For more
> +details, see the variable's docstring.  With Speed Keys activated,
> @kbd{M-x
> +org-speed-command-help} or @kbd{?}---when cursor is at the beginning of an
> +Org headline---shows currently active Speed Keys, including the
> user-defined
> +ones.
>
>
>  @node Code evaluation security
> --
> 2.13.0
>
>
> --
>
> Kaushal Modi
>
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 6662 bytes --]