From: Eli Zaretskii <eliz@gnu.org>
To: Damien Cassou <damien@cassou.me>
Cc: 56809@debbugs.gnu.org
Subject: bug#56809: file-name-with-extension: Improve docstring.
Date: Thu, 28 Jul 2022 12:40:37 +0300 [thread overview]
Message-ID: <83zggt8tii.fsf@gnu.org> (raw)
In-Reply-To: <878rod8tvc.fsf@cassou.me> (message from Damien Cassou on Thu, 28 Jul 2022 11:32:55 +0200)
> From: Damien Cassou <damien@cassou.me>
> 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.
next prev parent reply other threads:[~2022-07-28 9:40 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-28 6:31 bug#56809: file-name-with-extension: Improve docstring Damien Cassou
2022-07-28 7:49 ` Eli Zaretskii
2022-07-28 8:35 ` Damien Cassou
2022-07-28 8:57 ` Eli Zaretskii
2022-07-28 9:32 ` Damien Cassou
2022-07-28 9:40 ` Eli Zaretskii [this message]
2022-07-28 12:01 ` Damien Cassou
2022-07-28 13:34 ` Eli Zaretskii
2022-07-28 10:34 ` Visuwesh
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.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83zggt8tii.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=56809@debbugs.gnu.org \
--cc=damien@cassou.me \
/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.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).