From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#56809: file-name-with-extension: Improve docstring. Date: Thu, 28 Jul 2022 12:40:37 +0300 Message-ID: <83zggt8tii.fsf@gnu.org> References: <87edy5929v.fsf@cassou.me> <83ilnhad8j.fsf@gnu.org> <87bkt98wju.fsf@cassou.me> <837d3xaa2y.fsf@gnu.org> <878rod8tvc.fsf@cassou.me> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="10019"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 56809@debbugs.gnu.org To: Damien Cassou Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Jul 28 11:58:05 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1oH0HM-0002RU-Fb for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 28 Jul 2022 11:58:04 +0200 Original-Received: from localhost ([::1]:42892 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oH0HL-0002VR-2w for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 28 Jul 2022 05:58:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:38526) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oH00s-0002u8-Ry for bug-gnu-emacs@gnu.org; Thu, 28 Jul 2022 05:41:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:39651) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oH00s-0001I2-IN for bug-gnu-emacs@gnu.org; Thu, 28 Jul 2022 05:41:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1oH00s-00078T-9C for bug-gnu-emacs@gnu.org; Thu, 28 Jul 2022 05:41:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 28 Jul 2022 09:41:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 56809 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 56809-submit@debbugs.gnu.org id=B56809.165900123927387 (code B ref 56809); Thu, 28 Jul 2022 09:41:02 +0000 Original-Received: (at 56809) by debbugs.gnu.org; 28 Jul 2022 09:40:39 +0000 Original-Received: from localhost ([127.0.0.1]:57633 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oH00V-00077f-1R for submit@debbugs.gnu.org; Thu, 28 Jul 2022 05:40:39 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:53664) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oH00R-00077Q-Ng for 56809@debbugs.gnu.org; Thu, 28 Jul 2022 05:40:38 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:47320) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oH00L-0001Cy-Ku; Thu, 28 Jul 2022 05:40:29 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=1zKZlnBcXh2OYlxfPWds9AFI25vDpe7g4kcRg34g1+Q=; b=QuhOtnzJOJacudESSBTi Gp6E1MoN9pFz9lu5LyHsFeREa4xFH07Rc6EQnnfPgk6Maa9AVYHEeLQc/HJS0hd+gImDqln1IkenU U7sBdZalhqUaJp84luocv5FgrBsh2GelQ5opoPCE1cSG6EfnTQEyXYtX6IAKKy01ocqZhOUApsmjd R0gI0C287wUkMEI1sKP1N3tmWm3FAKFbSwIj/QkY1sG6oQgf1IPIWmZ5u71LAiXj6xteXoBarDuPO TEoZ16sy75E2biZz1VXWTqV2tp4SuxN+LvgTp6rXVVuanqEsd/fUf7a/HoNnYBM4SzsveNsXzmcw0 KGVo3PTKHAF7jA==; Original-Received: from [87.69.77.57] (port=4972 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oH00L-0003af-3V; Thu, 28 Jul 2022 05:40:29 -0400 In-Reply-To: <878rod8tvc.fsf@cassou.me> (message from Damien Cassou on Thu, 28 Jul 2022 11:32:55 +0200) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:238094 Archived-At: > From: Damien Cassou > Cc: 56809@debbugs.gnu.org > Date: Thu, 28 Jul 2022 11:32:55 +0200 > > >>> "Return FILENAME modified to… > >> > >> Most readers will know that FILENAME is not going to be modified but the > >> phrasing is still confusing in my opinion. > > > > Why confusing? > > To me, "Return FILENAME modified" means that FILENAME is going to be > modified but that is not true: FILENAME will still reference the same > place in memory and this place won't be changed either. Said > differently: I understand the sentence as "there is going to be some > side-effects" even though there are none. Well, the "return" part was supposed to prevent such an interpretation. Moreover, that sentence is just the summary; the doc string goes on to say This function removes any existing extension from FILENAME, and then appends EXTENSION to it. I could have the first sentence to say something like Return a file name made from the base name of FILENAME and EXTENSION. But is this really better? We'd need at least to explain what is a "base name" (and it's also a bit inaccurate, since "base name" generally means without the leading directories). > I agree it is inaccurate. The inaccuracy is acceptable to me in the > first sentence as this sentence is only meant to give an idea of what > the function is supposed to do. The rest of the docstring explains the > details and why it's not a simple concatenation. Well, the same is true for the "modified" part, isn't it? > As a conclusion, I'm fine with the docstring and you should merge it and > do more important stuff rather than discussing unimportant details with > me 😃. I'm sorry I made you loose your time. No need to be sorry, this is part of my job as a maintainer. Thanks.