Re: [PATCH v2] lisp/org.el: Add final hooks to S-/M-/S-M-cursor commands

[Ihor Radchenko]

Evgenii Klimov <eugene.dev@lipklim.org> writes:

> Maybe I got it wrong, but I tried to follow the docstring for
> `org-metaleft'. And I don't see here the use of the return value either:
>
> #+begin_example
>   (defun org-metaleft (&optional _arg)
>     "...
>     This function runs the hook `org-metaleft-hook' as a first step,
>     and returns at first non-nil value."
>     ...)
> #+end_example

> Should I keep it like this?
>   This function runs the hook `org-shiftmetaleft-hook' as a first
>   step, and `org-shiftmetaleft-final-hook' as the penultimate step.

Apparently the original wording is quite confusing.
What it is supposed to say is:

    This function runs the functions in `org-metaleft-hook' one by one
    as a first step, and exits immediately if a function from the hook
    returns non-nil.

-- 
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>