From: "João Távora" <joaotavora@gmail.com>
To: Robert Pluim <rpluim@gmail.com>
Cc: emacs-devel <emacs-devel@gnu.org>
Subject: Re: master e4896fc 1/2: Add a new 'flex' completion style
Date: Thu, 14 Feb 2019 14:50:45 +0000 [thread overview]
Message-ID: <CALDnm51pCh5Cg+fvwiHwGbQjWHYvFofgfr8p5hvhTQTF42yBwA@mail.gmail.com> (raw)
In-Reply-To: <m2sgwqzatz.fsf@gmail.com>
On Thu, Feb 14, 2019 at 2:47 PM Robert Pluim <rpluim@gmail.com> wrote:
> > To be clear, I agree this isn't the best docstring in the world. Is it
> > better than what was before, which was nothing? Perhaps that's
> > arguable and I shouldn't have added it in the first place, forcing
> > err inviting people like me to go read the source code. Doing
> > a good docstring is hard and I usually reserve those efforts for
> > user-visible functions. You could have very well asked me
> > what exactly a "PCM-style substring pattern" is, since that's
> > just as loosely defined as everything else around those
> > parts.
>
> Doing good docstrings is hard, which is why there will always be
> comments on them. Such comments are exactly that: comments, not
> criticism.
I apologize for that paragraph which reads harsher than it means.
I was also trying to get your opinion on what is better: writing a
subpar docstring for an internal function, or keeping it undocumented.
João
next prev parent reply other threads:[~2019-02-14 14:50 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20190213212413.868.40960@vcs0.savannah.gnu.org>
[not found] ` <20190213212414.D6F4C209C6@vcs0.savannah.gnu.org>
2019-02-14 12:38 ` master e4896fc 1/2: Add a new 'flex' completion style Robert Pluim
2019-02-14 13:50 ` João Távora
2019-02-14 14:37 ` Eli Zaretskii
2019-02-14 14:40 ` João Távora
2019-02-14 14:47 ` Robert Pluim
2019-02-14 14:50 ` João Távora [this message]
2019-02-14 15:12 ` Robert Pluim
2019-02-14 15:22 ` Drew Adams
2019-02-14 14:29 ` Eli Zaretskii
2019-02-14 14:39 ` João Távora
[not found] ` <20190213212415.148B9209D7@vcs0.savannah.gnu.org>
2019-03-16 1:13 ` [Emacs-diffs] master b0e318d 2/2: Score flex-style completions according to match tightness Dmitry Gutov
2019-03-16 13:02 ` João Távora
2019-03-16 13:19 ` Stefan Monnier
2019-03-16 14:25 ` João Távora
2019-03-17 18:06 ` Dmitry Gutov
2019-03-17 19:22 ` João Távora
2019-03-17 20:32 ` Dmitry Gutov
2019-03-17 21:46 ` João Távora
2019-03-18 14:26 ` Dmitry Gutov
2019-03-18 14:42 ` Dmitry Gutov
2019-03-18 14:49 ` Stefan Monnier
2019-03-18 14:52 ` Dmitry Gutov
2019-03-18 16:20 ` Stefan Monnier
2019-03-18 15:13 ` Who uses Icomplete-mode? " João Távora
2019-03-18 16:44 ` Stefan Monnier
2019-03-18 21:08 ` Who uses Icomplete-mode? Juri Linkov
2019-03-18 14:54 ` [Emacs-diffs] master b0e318d 2/2: Score flex-style completions according to match tightness João Távora
2019-03-18 14:51 ` João Távora
2019-03-18 17:18 ` Dmitry Gutov
2019-03-20 9:59 ` João Távora
2019-03-20 12:09 ` Stefan Monnier
2019-03-20 21:00 ` João Távora
2019-03-20 21:58 ` Dmitry Gutov
2019-03-20 23:25 ` João Távora
2019-03-21 1:14 ` Stefan Monnier
2019-03-21 1:20 ` Dmitry Gutov
2019-03-21 1:08 ` Stefan Monnier
2019-03-17 17:51 ` Dmitry Gutov
2019-03-17 19:09 ` João Távora
2019-03-17 20:22 ` Dmitry Gutov
2019-03-17 21:27 ` João Távora
2019-03-18 0:38 ` Dmitry Gutov
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=CALDnm51pCh5Cg+fvwiHwGbQjWHYvFofgfr8p5hvhTQTF42yBwA@mail.gmail.com \
--to=joaotavora@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=rpluim@gmail.com \
/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).