From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Richard Stallman Newsgroups: gmane.emacs.devel Subject: Re: Docstrings and manuals Date: Mon, 18 Apr 2016 04:38:43 -0400 Message-ID: References: <6ok2vyzwf9.fsf@fencepost.gnu.org> <08f70cda-44be-0657-e50a-2b2c80d2c21c@yandex.ru> <87oa9dzgl0.fsf@gmx.de> <87potshczh.fsf@gmx.de> <87h9f4ghzg.fsf@gmx.de> <8737qnc8ep.fsf@gmx.de> <87k2jwd3gr.fsf_-_@gmx.de> <8dfdfe5d-41fe-7c05-0054-0bd3e589390e@yandex.ru> <831t64b7l0.fsf@gnu.org> <3c95a1a7-a334-73e7-0644-71aa0d862b50@yandex.ru> Reply-To: rms@gnu.org NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1460968747 23732 80.91.229.3 (18 Apr 2016 08:39:07 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 18 Apr 2016 08:39:07 +0000 (UTC) Cc: rgm@gnu.org, eliz@gnu.org, michael.albinus@gmx.de, emacs-devel@gnu.org To: Dmitry Gutov Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 18 10:39:01 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1as4hv-000891-3m for ged-emacs-devel@m.gmane.org; Mon, 18 Apr 2016 10:38:59 +0200 Original-Received: from localhost ([::1]:33169 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1as4hu-0005sm-L1 for ged-emacs-devel@m.gmane.org; Mon, 18 Apr 2016 04:38:58 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58064) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1as4hp-0005om-QS for emacs-devel@gnu.org; Mon, 18 Apr 2016 04:38:54 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1as4ho-0004TW-PS for emacs-devel@gnu.org; Mon, 18 Apr 2016 04:38:53 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:42134) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1as4hi-0004PK-Oo; Mon, 18 Apr 2016 04:38:46 -0400 Original-Received: from rms by fencepost.gnu.org with local (Exim 4.82) (envelope-from ) id 1as4hf-0006Zw-IO; Mon, 18 Apr 2016 04:38:43 -0400 In-reply-to: <3c95a1a7-a334-73e7-0644-71aa0d862b50@yandex.ru> (message from Dmitry Gutov on Sun, 17 Apr 2016 18:15:17 +0300) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:203033 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. ]]] > > If you mean that mapatoms' doc string is too terse and omits some > > details it shouldn't, I agree. Otherwise, I'm not sure what you mean; > > please elaborate. > That someone saw fit to put "Then it returns ‘nil’" into the manual when > it's not in the docstring. And that it's easy to make such a mistake. That's not necessarily a flaw. The fact that mapatoms returns nil is not very important for using it. Maybe it is worth mentioning in the manual but not important enough for the doc string. -- Dr Richard Stallman President, Free Software Foundation (gnu.org, fsf.org) Internet Hall-of-Famer (internethalloffame.org) Skype: No way! See stallman.org/skype.html.