From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id WAWKNijJVmEA9QAAgWs5BA (envelope-from ) for ; Fri, 01 Oct 2021 10:39:04 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id EKRLMijJVmEUJwAA1q6Kng (envelope-from ) for ; Fri, 01 Oct 2021 08:39:04 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 7D82234420 for ; Fri, 1 Oct 2021 10:39:04 +0200 (CEST) Received: from localhost ([::1]:35892 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mWE4N-0003qJ-7B for larch@yhetil.org; Fri, 01 Oct 2021 04:39:03 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:51980) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mWE3v-0003pt-V5 for emacs-orgmode@gnu.org; Fri, 01 Oct 2021 04:38:35 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:52408) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mWE3v-00022W-NI; Fri, 01 Oct 2021 04:38:35 -0400 Received: from [78.194.183.21] (port=54526 helo=hal) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mWE3v-0005IE-HL; Fri, 01 Oct 2021 04:38:35 -0400 Received: by hal (Postfix, from userid 1000) id 3ADBE1E041F; Fri, 1 Oct 2021 10:38:33 +0200 (CEST) From: Bastien To: =?utf-8?Q?Andr=C3=A9?= A. Gomes Subject: Re: [PATCH] Rename headline to heading In-Reply-To: <87zgruw8wx.fsf@gmail.com> (=?utf-8?Q?=22Andr=C3=A9?= A. Gomes"'s message of "Thu, 30 Sep 2021 15:21:50 +0300") Organization: GNU References: <871r786qfe.fsf@gmail.com> <87pmsv4rfy.fsf@bzg.fr> <87zgruw8wx.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.60 (gnu/linux) Date: Fri, 01 Oct 2021 10:38:33 +0200 Message-ID: <87ee953zsm.fsf@bzg.fr> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: emacs-orgmode@gnu.org Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1633077544; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=IB6raqqcHMOkD2lUJemLSPP0IOXA2IPg03GqD9l4st8=; b=Td1yFA+7+QkKP9tkVGvEaEe4VMDC4CPXnMfv7lmZ0ABILXHE67+Ih5SdBkBENgJTfNtTx2 dWjFCFfAo4h42mca5xHSfIaPFpukJ0wTJiJ72gLMoyVXeWjYsUxwcT4emOc4tUI4tGcci/ AZv10Zekq0EiszlxScKCBHiPYRsCXstt9tTtRHoMr+ZXv3PxDU7eEfZ4HMZnDyeEQOLXDx ak6y82XxwlqCu6SGgtc0MZ61AyWIjQGDmxTs8ajz5goUWRHDbVu4xLLmfeMQC2TDHO2Ym9 KZ8SB9UKvL7gKgcpqOJvRDueku6VDrFr6b+5axnD7Uc0P5m2rBI6VdUeqDdBzQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1633077544; a=rsa-sha256; cv=none; b=tApvhm1OS8tD+Sc6c6rlg8Db0XPiAjg2FUXea3G7TGgWkcT3JHRJ3CKmZXLdVmnoGIloV7 Uo1BIwl8wab2s2O4xWfdxNiQqvlrLB8tXUsg76CPcp1/qhfHnMBkQmdbFt+K+ooKcBAOeb arDCbusO35KYa51SwH62CJye9Ax/QWM6qVRtGkwbsBj26/DNvVUKDTrjjpIxP1zw/vabHX BUjfb0itp6hzugsdW0ceRrGjJgHh79HpYFQJvLgrtp98WjYmMDchdOHICYw6LLs/jCzgzI d79ujdsjVEzga7Mh7QEfgMrjCcGzk58bxF3Vt+LoWY3VOw2k7VQExY4XCPuXVg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -2.00 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: 7D82234420 X-Spam-Score: -2.00 X-Migadu-Scanner: scn1.migadu.com X-TUID: FCd0Jc44wr5q Hi Andr=C3=A9, Andr=C3=A9 A. Gomes 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! --=20 Bastien