From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.devel Subject: Re: Docstrings and manuals Date: Tue, 19 Apr 2016 10:59:56 +0300 Message-ID: <9ba2fbfe-9334-a07f-4b63-2e48d381c5f3@yandex.ru> 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> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1461052826 24093 80.91.229.3 (19 Apr 2016 08:00:26 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 19 Apr 2016 08:00:26 +0000 (UTC) Cc: rgm@gnu.org, eliz@gnu.org, michael.albinus@gmx.de, emacs-devel@gnu.org To: rms@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Apr 19 10:00:24 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 1asQa8-0007Nx-Ht for ged-emacs-devel@m.gmane.org; Tue, 19 Apr 2016 10:00:24 +0200 Original-Received: from localhost ([::1]:53405 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1asQa8-0000zc-3O for ged-emacs-devel@m.gmane.org; Tue, 19 Apr 2016 04:00:24 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:53802) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1asQZm-0000oz-U0 for emacs-devel@gnu.org; Tue, 19 Apr 2016 04:00:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1asQZj-0000QW-PN for emacs-devel@gnu.org; Tue, 19 Apr 2016 04:00:02 -0400 Original-Received: from mail-wm0-x242.google.com ([2a00:1450:400c:c09::242]:34748) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1asQZj-0000QM-IR; Tue, 19 Apr 2016 03:59:59 -0400 Original-Received: by mail-wm0-x242.google.com with SMTP id n3so2727370wmn.1; Tue, 19 Apr 2016 00:59:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:subject:to:references:cc:from:message-id:date:user-agent :mime-version:in-reply-to:content-transfer-encoding; bh=yCf/h6F1K4tNDKWmOf89sCgnr+9/p1NTzZdMMyqc3Fc=; b=qLDctM6jfJdh5mW4TXqcGGWwHuzxXDRkf1nFbMw4MPLXy/13i29r+A2Bmh1XdjZflj /Mkjw9Upn66KTp6lsrj2fLF7BtL9E9WcB2bkFOv0yC2ASPGXWtRh9tGUYjGUAFEqL3aj ILDTn+2/a1DSgUNFXbrOc7Cv/Gr8CY4c+HMSrfCnC/Lhn7cegoLGzEDwpNKMrPczDlbC UqFlWafYkCRNvS+IEM1uMVlF0Y9euAWuWS3Le4MI+pzQQqYus9FyYAWGlT1LsVRSPBD6 CseAfygpydaIXB67h05XzJbzE8CAkSHonCsTYXo/vnGTMwlYx15iyENXIgfqMxjoG2Vr Au7Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:sender:subject:to:references:cc:from:message-id :date:user-agent:mime-version:in-reply-to:content-transfer-encoding; bh=yCf/h6F1K4tNDKWmOf89sCgnr+9/p1NTzZdMMyqc3Fc=; b=UqGMxPqlaWf7U5sCvJgZJ8sjBuqxkcZ4bGgSsFIky8XB3Rl1B1UN9Dv44NQSDrwwuQ u5Ii0b+cE5LFpgejfm+y95C/xAiqKnxceJjcpiu0ZZyKydVuu1YU1QeLzokeVLtaRuIf JvcdTKsbzyaoJrOgKt5lG0RpYVvlg31Q2vNepCufdVJjXTGBKvI4YqRh4vGS/WJAM9tE Wz9t18wW85VjqPMMAavTM2/2z2CjggBhQ/l1bLY9pvhC3i+lC3QNT65CJ0NiRCWVyXTm 9t5eToF64dAgQAO/RXelCVPEaE3WFAK0elHv8WznEwb1+Admgn3UAxDW26j9cQVLbDMd o5lw== X-Gm-Message-State: AOPr4FX3JGPukISH7UhG6RMZcoD5uJjZkYgtvyRkPwRp9p1ZmhDfHvlm7McOv2m0xio2kQ== X-Received: by 10.28.54.208 with SMTP id y77mr21690965wmh.17.1461052798776; Tue, 19 Apr 2016 00:59:58 -0700 (PDT) Original-Received: from [192.168.1.2] ([185.105.175.24]) by smtp.googlemail.com with ESMTPSA id om6sm67996767wjc.40.2016.04.19.00.59.57 (version=TLSv1/SSLv3 cipher=OTHER); Tue, 19 Apr 2016 00:59:58 -0700 (PDT) User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.0 In-Reply-To: X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2a00:1450:400c:c09::242 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:203085 Archived-At: On 04/19/2016 03:25 AM, Richard Stallman wrote: > Since the return value is documented in the manual, it is something > we would not change without a good reason. However, that doesn't mean > it needs to be stated in the doc string. That sounds silly to me. At the very least, not mentioning a behavior in the docstring makes it easier to violate. Docstrings are changes together with the code, but we allow deferring manual updates.