From: "André A. Gomes" <andremegafone@gmail.com>
To: Bastien <bzg@gnu.org>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Rename headline to heading
Date: Thu, 30 Sep 2021 15:21:50 +0300 [thread overview]
Message-ID: <87zgruw8wx.fsf@gmail.com> (raw)
In-Reply-To: <87pmsv4rfy.fsf@bzg.fr> (Bastien's message of "Sun, 26 Sep 2021 11:27:45 +0200")
Bastien <bzg@gnu.org> writes:
> Hi André,
>
> I agree this change is a welcome improvement: thanks a lot for working
> on this patch. I would like to suggest a step by step approach:
>
> 1. Updating occurrences in the documentation: manual, guide,
> docstrings, worg occurences, etc.
>
> 2. Updating Org internals without impacting users' configuration
> (i.e. update the functions and variables name, but don't update
> the "file+headline" config string.)
>
> 3. If the "file+headline" config string is the only part of a config
> that can be impacted by this change, support both the new and old
> strings for backward compatibility.
>
> We don't need a transition period for the first two changes, and we
> don't need one either for the third one if we implement the backward
> compatible solution. We need a transition period if we remove it, but
> I'm not convinced removing it is really needed now.
>
> What do you think?
Hi Bastien,
Sorry for my late reply.
Overall, I agree with the suggested approach.
Here's something I wasn't sure about when I worked on it. How should I
distribute the changes commit-wise? Tom Gillespie, for instance,
suggested separating documentation and docstring from internals.
I think it's ok to separate internals from documentation (manuals). But
when it comes to docstrings, it feels a bit odd. Say there's a function
named foo-headline whose docstring contains the string headline. Then
there would be a commit where the function continues to have headline in
its definition, but the docstring contains heading. Shouldn't we avoid
such a "grey area" snapshot?
I could create a bunch of small and well documented patches, that in the
end would be squashed before merging into master. Perhaps it would even
make sense to have a branch for a while so that people would test it.
This way everyone gets a fine grain for inspection, while in the end we
get a huge "/s/headline/heading" commit.
If someone has better ideas, please share. I will take a look at this
perhaps next week. Thank you.
--
André A. Gomes
"Free Thought, Free World"
next prev parent reply other threads:[~2021-09-30 12:23 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-05 12:12 [PATCH] Rename headline to heading André A. Gomes
2021-08-05 15:04 ` Maxim Nikulin
2021-08-14 22:54 ` Tim Cross
2021-08-15 16:22 ` No Wayman
2021-08-15 16:50 ` No Wayman
2021-08-15 22:32 ` Jim Porter
2021-08-15 23:17 ` Tim Cross
2021-08-16 0:38 ` Jim Porter
2021-08-16 1:18 ` Tim Cross
2021-08-08 16:59 ` Tom Gillespie
2021-08-14 23:19 ` Tim Cross
2021-09-19 11:06 ` Timothy
2021-09-30 12:08 ` André A. Gomes
2021-09-26 9:27 ` Bastien
2021-09-30 12:21 ` André A. Gomes [this message]
2021-10-01 8:38 ` Bastien
2021-10-15 8:52 ` André A. Gomes
2021-10-15 9:56 ` Timothy
2021-10-15 10:18 ` André A. Gomes
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=87zgruw8wx.fsf@gmail.com \
--to=andremegafone@gmail.com \
--cc=bzg@gnu.org \
--cc=emacs-orgmode@gnu.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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).