emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Question on set-window-margins


From: Richard Stallman
Subject: Re: Question on set-window-margins
Date: Fri, 05 Jan 2024 23:35:38 -0500

[[[ 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)





reply via email to

[Prev in Thread] Current Thread [Next in Thread]