Re: Suggestion: for each listed keybinding, also name the command

[Ihor Radchenko]

Yuval Langer <yuval.langer@gmail.com> writes:

> I have:
>
> - Added all the obvious commands to the `- {{{kbd(…)}}} ::` lines.

Thanks, but after your patch the manual does not compile.
Did you try to generate the guide via "make docs" after the patch?

> - Left several of these lines without a command where I've the manual
> do the same.

May you please list these?

> -- {{{kbd(S-TAB)}}}, {{{kbd(C-u TAB)}}} ::
> +- {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} ::

Why nothing for C-u TAB?

> -- {{{kbd(C-c C-l)}}} (with point on existing link) ::
> +- {{{kbd(C-c C-l)}}} (with point on existing link) (~org-insert-link~) ::

This is inconsistent with other similar cases, where the key binding is
followed by some text. You added command name right after the key
binding, not after the text.
  
> -- {{{kbd(C-c C-c)}}} ::
> +- {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~), {{{kbd(C-u C-c C-c)}}} ::

Why nothing for C-u ... ?
  
> -- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} ::
> +- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::

What about C-c / ?
  
>  #+attr_texinfo: :sep or
> -- {{{kbd(C-c [)}}} ::
> +- {{{kbd(C-c [)}}} (~org-agenda-file-to-front~) ::

Please, pay attention to :sep list attribute (see 13.14.9 Plain lists in
Tex info export). You need to change it here because "or" separator no
longer works as the command name contains "..or..". This change makes
the compilation fail.

Basically, you need to change the separator to, say, ";" and alter the
following list items accordingly. 

>    Add current file to the list of agenda files.  The file is added to
>    the front of the list.  If it was already in the list, it is moved
>    to the front.  With a prefix argument, file is added/moved to the
>    end.
>  
> -- {{{kbd(C-c ])}}} ::
> +- {{{kbd(C-c ])}}} (~org-remove-file~) ::

Same here.
  
> -- {{{kbd(r)}}}, {{{kbd(g)}}} ::
> +- {{{kbd(r)}}} (~org-agenda-redo~), {{{kbd(g)}}} ::

Why nothing for "g"?

>  #+attr_texinfo: :sep ,
> -- {{{kbd(C-c C-e t a)}}}, {{{kbd(C-c C-e t u)}}} ::
> +- {{{kbd(C-c C-e t a)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t 
> u)}}} ::

What about C-c C-e t u?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>