From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Richard Stallman Newsgroups: gmane.emacs.devel Subject: Re: Question on set-window-margins Date: Fri, 05 Jan 2024 23:35:38 -0500 Message-ID: References: <83il4bzgmk.fsf@gnu.org> <83h6jvyu9p.fsf@gnu.org> <5FC2FDA6-CB7F-4285-958E-EC8595FC66AE@gmail.com> <834jfuzhg1.fsf@gnu.org> <83r0iyxsym.fsf@gnu.org> <83ttntw9a6.fsf@gnu.org> Reply-To: rms@gnu.org Content-Type: text/plain; charset=Utf-8 Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="32762"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Jan 06 05:35:50 2024 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rLyPW-0008JI-51 for ged-emacs-devel@m.gmane-mx.org; Sat, 06 Jan 2024 05:35:50 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rLyPO-0006pn-6x; Fri, 05 Jan 2024 23:35:42 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rLyPM-0006oF-4Q for emacs-devel@gnu.org; Fri, 05 Jan 2024 23:35:40 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rLyPL-0003V8-Rj for emacs-devel@gnu.org; Fri, 05 Jan 2024 23:35:39 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=Date:References:Subject:In-Reply-To:To:From: mime-version; bh=7Wqe6k+hD2REhdPAnVCLtt3xWCbU0VCmj6KfvasR92w=; b=IwNYD93cZtjo aIwmFLaXytZoBtzV5ox303UKX/Exx4wPL+KTI7JEIdiDII2OQhKWCTEma41n8qp4qXObkw5y6ywVp pcuDFf9ZmytgPgTXps5ObF2SjzGAfp1LRsF4hH0U9tfBpE+GwouZuw/0623ggi26oA05nYUx8+RU3 0SC4a295E0GLulDXJYJbiv2H65N9/yIYzTHfjKByAlPCfmAj1Qf4NCJ4LNWiY0hiT4adH+59tTg9r p8YR/9/OgocoXIAtwrqjbdLyZD/PIyrf/KDvLL/Mq2Y+fUSv5uU0dMWZVpevAw7o/sydBadfncNmU WkyhWd7mJF2lS6iQIbAtZw==; Original-Received: from rms by fencepost.gnu.org with local (Exim 4.90_1) (envelope-from ) id 1rLyPK-0003Yb-Is; Fri, 05 Jan 2024 23:35:38 -0500 In-Reply-To: <83ttntw9a6.fsf@gnu.org> (message from Eli Zaretskii on Thu, 04 Jan 2024 14:52:17 +0200) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:314585 Archived-At: [[[ 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)