From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: master 1e3b0f2: Improve doc strings of project.el Date: Mon, 13 Jul 2020 11:53:27 +0300 Message-ID: <9414A931-C678-4741-8B77-4F9FD2ECC339@gnu.org> References: <87bllfqj82.fsf@warpmail.net> <83mu4fvjh3.fsf@gnu.org> <7c2e93d4-8d86-bbbb-77a0-bf5d73051907@yandex.ru> <83imf2t4w4.fsf@gnu.org> <95fd893e-0da5-4cdc-a3e8-3c22af750aae@yandex.ru> <837dvfs6wg.fsf@gnu.org> <8bc1f381-248f-5cee-c3c6-a29d411a2f74@yandex.ru> <837dvbphs0.fsf@gnu.org> <83365zp78d.fsf@gnu.org> <831rlipmgg.fsf@gnu.org> <83lfjqnsa6.fsf@gnu.org> <294212ed-5a6e-0a7f-e1c2-97e917f1e6e1@yandex.ru> <83eepgomts.fsf@gnu.org> <83a704okmg.fsf@gnu.org> <5d59dd9b-0848-691a-615e-c16d2070b92d@yandex.ru> <837dv8oida.fsf@gnu.org> <834kqcoghk.fsf@gnu.org> <99bb8976-580a-ef8e-6b7d-130c3ca5cb8a@yandex.ru> <83y2nom3hy.fsf@gnu.org> <455BA940-0BFF-4229-A60D-D33A2FF3385B@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11630"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: K-9 Mail for Android To: Gregory Heytings , "Gregory Heytings via Emacs development discussions." , emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Jul 13 10:54:04 2020 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 1juuDs-0002ts-0f for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Jul 2020 10:54:04 +0200 Original-Received: from localhost ([::1]:58374 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1juuDr-0001v5-11 for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Jul 2020 04:54:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50740) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1juuDO-0001Rk-Mt for emacs-devel@gnu.org; Mon, 13 Jul 2020 04:53:34 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:59555) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1juuDM-0001zY-15; Mon, 13 Jul 2020 04:53:32 -0400 Original-Received: from [176.12.222.55] (port=56009 helo=[10.160.127.200]) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1juuDL-0007y9-0U; Mon, 13 Jul 2020 04:53:31 -0400 In-Reply-To: X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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" Xref: news.gmane.io gmane.emacs.devel:252908 Archived-At: On July 13, 2020 10:52:57 AM GMT+03:00, "Gregory Heytings via Emacs develop= ment discussions=2E" wrote: >=20 > > IOW, doing that does NOT make these details part of the public API > which=20 > > we promise shall remain stable=2E > > >=20 > I might be wrong, but in that case I think Dmitry's viewpoint is that > this=20 > information should not be placed in the doc strings, but in the > comments=20 > in the source file=2E Maybe so, but the suggestion to move what I added to the doc strings into = comments was never voiced by Dmitry until the very last message, and even t= here he is still firmly against documenting the form of the return value, n= o matter where=2E