From: Eli Zaretskii <eliz@gnu.org>
To: help-gnu-emacs@gnu.org
Subject: Re: [Solved]
Date: Sun, 15 Aug 2010 01:27:26 +0300 [thread overview]
Message-ID: <8362zcu8xd.fsf@gnu.org> (raw)
In-Reply-To: <8762zdrmju.fsf@mean.albasani.net>
> From: Memnon Anon <gegendosenfleisch@googlemail.com>
> Cc: help-gnu-emacs@gnu.org
> Date: Sat, 14 Aug 2010 23:18:21 +0200
>
> Eli Zaretskii <eliz@gnu.org> writes:
>
> > I urge you to reconsider. Sending an email saying that the doc string
> > of org-clock-in does not say what value to assign to the SELECT
> > argument in a non-interactive call does not need any high level of
> > expertise.
>
> Sending the mail does not need expertise. But recognizing if something
> really is a deficiency does. Bug reports are great, but creating
> "noise" is not; and I really don't want to be a nuisance to the experts
> who provide me with so excellent tools. And even if I did recognize a
> lack of precision - which requires some knowledge of best practice in
> doc strings - I would want to send a patch, which requires even more
> knowledge of doc strings in general (= not only seeing what is wrong but
> also 'fixing' it).
Sending a patch is fine. But if you cannot send a patch, at least
make a bug report. Doing nothing after you spotted a problem is IMO
worse than sending a bug report out of mistake or misunderstanding.
> One way is looking for other docstrings that seem to be "better".
> In org, I found lots of functions that are usually called interactively
> that have a doc string like the one before.
Even more reason to submit a report: it sounds like many doc strings
there need the same treatment.
> Should I really file bug reports when I obviously do not understand
> whats going on?
Yes. An unclear doc string needs improvement.
next prev parent reply other threads:[~2010-08-14 22:27 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-13 14:37 Prefix-Arg (non-interactive!) in Info Memnon Anon
2010-08-13 15:17 ` Eli Zaretskii
2010-08-13 15:50 ` Memnon Anon
2010-08-13 16:09 ` Eli Zaretskii
2010-08-13 16:21 ` Drew Adams
2010-08-13 18:36 ` Memnon Anon
2010-08-13 20:33 ` Drew Adams
2010-08-13 17:04 ` Memnon Anon
2010-08-13 17:40 ` Andreas Röhler
2010-08-13 21:04 ` Memnon Anon
2010-08-13 19:33 ` Eli Zaretskii
2010-08-13 20:58 ` [Solved] (was: Prefix-Arg (non-interactive!) in Info) Memnon Anon
2010-08-14 8:05 ` Eli Zaretskii
2010-08-14 21:18 ` [Solved] Memnon Anon
2010-08-14 22:27 ` Eli Zaretskii [this message]
-- strict thread matches above, loose matches on Subject: below --
2021-10-06 15:53 how to randomize (scample) regions in a an (org) buffer Uwe Brauer
2021-10-06 16:35 ` [SOLVED] (was: how to randomize (scample) regions in a an (org) buffer) Uwe Brauer
2021-10-06 19:59 ` Emanuel Berg via Users list for the GNU Emacs text editor
2021-10-06 20:24 ` [SOLVED] Uwe Brauer
2021-10-06 20:58 ` [SOLVED] Emanuel Berg via Users list for the GNU Emacs text editor
2021-10-07 7:05 ` [SOLVED] Uwe Brauer
2021-10-07 8:15 ` [SOLVED] Emanuel Berg via Users list for the GNU Emacs text editor
2022-07-23 16:45 problems with better-registers: turn-off-all-minor modes or remove all text-properties Uwe Brauer
2022-07-24 0:09 ` Michael Heerdegen
2022-07-24 3:59 ` Michael Heerdegen
2022-07-24 5:39 ` Uwe Brauer
2022-07-24 19:51 ` [SOLVED] (was: problems with better-registers: turn-off-all-minor modes or remove all text-properties) Uwe Brauer
2022-07-24 22:36 ` [SOLVED] Michael Heerdegen
2022-07-25 5:37 ` [SOLVED] Uwe Brauer
2022-07-25 5:49 ` [SOLVED] Uwe Brauer
2022-07-25 17:09 ` [SOLVED] Stefan Monnier via Users list for the GNU Emacs text editor
2022-07-25 19:49 ` [SOLVED] Uwe Brauer
2022-07-25 22:37 ` [SOLVED] Michael Heerdegen
2022-07-26 4:57 ` [SOLVED] Uwe Brauer
2022-07-26 13:01 ` [SOLVED] Thorsten Bonow
2022-07-26 15:02 ` [SOLVED] Uwe Brauer
2022-07-26 16:23 ` [SOLVED] Yuri Khan
2022-07-26 23:28 ` [SOLVED] Michael Heerdegen
2022-07-27 10:50 ` [SOLVED] Uwe Brauer
2022-07-27 15:04 ` [SOLVED] Yuri Khan
2022-07-28 14:46 ` [SOLVED$ Uwe Brauer
2022-10-02 20:18 add-log-time-format with time? Uwe Brauer
2022-10-03 6:49 ` [SOLVED] (was: add-log-time-format with time?) Uwe Brauer
2022-10-03 11:33 ` Emanuel Berg
2022-10-09 5:51 ` [SOLVED] Uwe Brauer
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=8362zcu8xd.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=help-gnu-emacs@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.
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).