On 04 Apr 2022, Ihor Radchenko wrote:
From bb229b4f8f78ae52962d7bc90c8b1d4993af8263 Mon Sep 17 00:00:00 2001
From: Karl Fogel <kfo...@red-bean.com>
Date: Thu, 31 Mar 2022 19:02:38 -0500
Subject: [PATCH] Mark function obsolete & fix spelling of its name

This commit message is a bit confusing. I would mention the function name: "Mark `org-truely-invisible-p' obsolete and fix spelling of its
name"

* lisp/org-macs.el (org-truely-invisible-p): Move to...
* lisp/org-compat.el (org-truly-invisible-p): ...here, and add...
  (org-truely-invisible-p): ...this compatibility alias.

It does mention both names :-). But I'm happy to rewrite in the style you suggest above; I was just trying to follow the CONTRIBUTE guidelines.

It is too much.
We can either
1. Obsolete org-truely-invisible-p. Then, there is not much point
  renaming it.
2. Rename it without obsoletion. Then, there is not much point moving
  the function definition to org-compat.

Hmm. From the prior conversation in this thread, I thought we'd decided to do both. There are two separate issues here:

1) The function is no longer used in Org Mode or Emacs.

2) Unrelatedly, the function's name has a misspelling.

(1) suggests that the function should be moved to 'org-compat.el' (if I understand correctly what that file is for).

(2) is usually fixed with a rename and a compatibility alias -- i.e., this is what we would do for any function, whether used or unused.

In your message 87h7b5rm6f.fsf@localhost of 19 Dec 2021, you wrote:

I feel slightly reluctant about removal. If nothing, this function can be a reminder about visible-mode and keeping it has little downside. Though if others think that removing would be better, I would also be
fine with it.

Renaming sounds reasonable. Just need to define obsolete alias for the
old name in org-compat.el.

My patch was based on the above, and on the fact that obsolete (i.e., unused) functions apparently get moved to org-compat.el, at least based on what I see already in that file.

  From: Ihor Radchenko
Subject: Re: Removing obsolete function `org-truely-invisible-p'.
  To: Karl Fogel
  Cc: Org Mode
  Date: Sun, 19 Dec 2021 17:14:32 +0800
  Message-ID: <87h7b5rm6f.fsf@localhost>

I usually just leave an ML link in such cases:
https://orgmode.org/list/87h7b5rm6f.fsf@localhost

As long as the ML link contains the Message-ID, as appears to be the case here, yeah. Mailing list archives can move, which causes links to suddenly stop working. But if the Message-ID is in the link, then (with a little extra work) one can always find the message in the new archive.

(The reason I typically include more is to make things as easy as possible for those who are searching in a local archive using their regular mailreader. But I can switch to the above way if you'd prefer.)

Best regards,
-Karl

Reply via email to