emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Ihor Radchenko <yantar92@posteo.net>
To: Evgenii Klimov <eugene.dev@lipklim.org>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH v2] lisp/org.el: Add final hooks to S-/M-/S-M-cursor commands
Date: Mon, 03 Jul 2023 12:44:34 +0000	[thread overview]
Message-ID: <87ilb1go5p.fsf@localhost> (raw)
In-Reply-To: <20230701131902.1679-1-eugene.dev@lipklim.org>

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

> ...

Thanks for the update.

Few comments.

First, please add Changelog entry for etc/ORG-NEWS.

> +(defvar org-metaleft-final-hook nil
> +  "Hook for functions attaching themselves to `M-left'.
> +See `org-ctrl-c-ctrl-c-hook' for more information.")

Note that unlike the docstring your added, `org-shiftup-final-hook'
specifies when the hook is executed:

(defvar org-shiftup-final-hook nil
  "Hook for functions attaching themselves to `S-up'.
This one runs after all other options except shift-select have been excluded.
See `org-ctrl-c-ctrl-c-hook' for more information.")

It is better to follow the pattern and clarify the purpose of the hook
better instead of leaving docstrings for both the -final and other hook
same.

> +individual commands for more information.
> +
> +This function runs the hook `org-shiftmetaleft-hook' as a first
> +step, `org-shiftmetaleft-final-hook' as the penultimate step, and
> +returns at first non-nil value."

Upon looking closer, I realized that you also defined return value of
the function here.  Is there any particular reason for this? The return
value is currently not defined and supposed to be discarded.

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

next prev parent reply	other threads:[~2023-07-03 12:45 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-29 22:31 Add final hooks to S-/M-/S-M-cursor commands Evgenii Klimov
2023-06-29 22:31 ` [PATCH 1/3] lisp/org.el: Add final hooks to the M-cursor commands Evgenii Klimov
2023-06-29 22:31 ` [PATCH 2/3] lisp/org.el: Fix docstring for S-cursor commands Evgenii Klimov
2023-06-29 22:31 ` [PATCH 3/3] lisp/org.el: Add final hooks to the S-M-cursor commands Evgenii Klimov
2023-07-01 10:40 ` Add final hooks to S-/M-/S-M-cursor commands Ihor Radchenko
2023-07-01 12:16   ` Evgenii Klimov
2023-07-01 12:22     ` Ihor Radchenko
2023-07-01 13:19   ` [PATCH v2] lisp/org.el: " Evgenii Klimov
2023-07-03 12:44     ` Ihor Radchenko [this message]
2023-07-03 19:40       ` Evgenii Klimov
2023-07-04 11:34         ` Ihor Radchenko
2023-07-04 22:28       ` [PATCH v3] " Evgenii Klimov
2023-07-05 10:46         ` Ihor Radchenko
2023-07-05 11:14           ` Evgenii Klimov
2023-07-05 11:27             ` Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87ilb1go5p.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=eugene.dev@lipklim.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).