From: Bastien <bzg@gnu.org>
To: "André A. Gomes" <andremegafone@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Rename headline to heading
Date: Fri, 01 Oct 2021 10:38:33 +0200 [thread overview]
Message-ID: <87ee953zsm.fsf@bzg.fr> (raw)
In-Reply-To: <87zgruw8wx.fsf@gmail.com> ("André A. Gomes"'s message of "Thu, 30 Sep 2021 15:21:50 +0300")
Hi André,
André A. Gomes <andremegafone@gmail.com> writes:
> 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.
Yes, that's what I suggest too.
> 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?
In general yes, but for this change, I find it easier to review and to
test the change with the plan I suggested: 1) only documentation-fixes
then 2) internals with no impact on the user then 3) internals with
impact on the user.
> 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.
I think you can send just patches for the three steps, I'd rather avoid
creating a remote branch just for this.
> If someone has better ideas, please share. I will take a look at this
> perhaps next week. Thank you.
Thank you for this (parly boring but needed) work!
--
Bastien
next prev parent reply other threads:[~2021-10-01 8:39 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
2021-10-01 8:38 ` Bastien [this message]
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=87ee953zsm.fsf@bzg.fr \
--to=bzg@gnu.org \
--cc=andremegafone@gmail.com \
--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).