From: Richard Stallman <rms@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: Question on set-window-margins
Date: Fri, 05 Jan 2024 23:35:38 -0500 [thread overview]
Message-ID: <E1rLyPK-0003Yb-Is@fencepost.gnu.org> (raw)
In-Reply-To: <83ttntw9a6.fsf@gnu.org> (message from Eli Zaretskii on Thu, 04 Jan 2024 14:52:17 +0200)
[[[ To any NSA and FBI agents reading my email: please consider ]]]
[[[ whether defending the US Constitution against all enemies, ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]
> That's not that easy, in general, since the manuals include a lot of
> background explanations, cross-references to other related places,
> etc., which are not pertinent for doc strings, but are still useful in
> some, mostly rare, situations.
This is true, but I would state it in a stronger way. You can't write
a good manual by concatenating doc strings. A doc string describes
one thing. A good manual is not composed of pieces, each about one
thing. That's not good writing for a manual.
See the GNU Coding Standards for more about this point, and how to
write a good manual.
--
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)
prev parent reply other threads:[~2024-01-06 4:35 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-02 17:58 Question on set-window-margins Nicolas P. Rougier (inria)
2024-01-02 19:20 ` Eli Zaretskii
2024-01-02 19:46 ` Nicolas P. Rougier (inria)
2024-01-03 3:23 ` Eli Zaretskii
2024-01-03 3:42 ` Yuan Fu
2024-01-03 5:50 ` Nicolas P. Rougier (inria)
2024-01-03 13:15 ` Eli Zaretskii
2024-01-03 14:05 ` Nicolas P. Rougier (inria)
2024-01-03 16:46 ` Eli Zaretskii
2024-01-03 17:24 ` Nicolas P. Rougier (inria)
2024-01-03 17:28 ` Eli Zaretskii
2024-01-03 17:56 ` Nicolas P. Rougier (inria)
2024-01-03 21:52 ` Jeremy Bryant
2024-01-04 8:53 ` Nicolas P. Rougier (inria)
2024-01-03 15:11 ` John Yates
2024-01-03 16:49 ` Eli Zaretskii
2024-01-03 20:07 ` [External] : " Drew Adams
2024-01-04 12:29 ` John Yates
2024-01-04 12:52 ` Eli Zaretskii
2024-01-05 0:25 ` Yuan Fu
2024-01-05 8:01 ` Eli Zaretskii
2024-01-06 4:35 ` Richard Stallman [this message]
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=E1rLyPK-0003Yb-Is@fencepost.gnu.org \
--to=rms@gnu.org \
--cc=eliz@gnu.org \
--cc=emacs-devel@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.
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).