From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Newsgroups: gmane.emacs.devel Subject: Re: Opaque objects and Emacs documentation Date: Tue, 21 Jul 2020 10:57:35 +0200 Message-ID: <20200721085735.GA446@tuxteam.de> References: <6edffb7d-7708-534f-93ad-bf9180f5e0ed@yandex.ru> <835zamjsvk.fsf@gnu.org> <831rlajock.fsf@gnu.org> <1fcdc463-b3ab-2d32-31d7-904783ae0d81@yandex.ru> <83y2nii6sk.fsf@gnu.org> <69716ecb-8984-23e0-8b44-322ea3582384@yandex.ru> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="X1bOJ3K7DJ5YkBrT" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="34406"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/1.5.21 (2010-09-15) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Jul 21 10:58:28 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 1jxo6W-0008qe-G6 for ged-emacs-devel@m.gmane-mx.org; Tue, 21 Jul 2020 10:58:28 +0200 Original-Received: from localhost ([::1]:54532 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jxo6V-00074C-IE for ged-emacs-devel@m.gmane-mx.org; Tue, 21 Jul 2020 04:58:27 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53580) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jxo5l-0006Qm-Lz for emacs-devel@gnu.org; Tue, 21 Jul 2020 04:57:41 -0400 Original-Received: from mail.tuxteam.de ([5.199.139.25]:49802) by eggs.gnu.org with esmtps (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.90_1) (envelope-from ) id 1jxo5j-0004Wn-7v for emacs-devel@gnu.org; Tue, 21 Jul 2020 04:57:41 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tuxteam.de; s=mail; h=From:In-Reply-To:Content-Type:MIME-Version:References:Message-ID:Subject:To:Date; bh=Eg02xOGOjum9sXOCp0+crGmbx5X9OUWXK2R3lKQdEoE=; b=akTRxpDTIy9f584ciYieY6VNDN/5rIB9B9785e3gnk+H5aR5UwuzhJRZQUc6cVhRtySxid1lY7T75zkmiylxUV094XHq3mIRmLRifV0w0DLHIgoQPA7pwwRdgCbmWOSLs5fBvOvSk8/QjkMJgRCT7kt01xUbOqAALvML2giWSBXDK+zHicNJMPWMz4JxVCrL6JcqfqAFORCi02TRdFqXBxMH8dTJJXitYfFDmUuFTkJpmJzDUgt49im7sfbRmmZAW2wXHmf+0LAGMqE+en93R6RQI6EWKfZHhX83ZpOKyrRqoTMa/lTHkn4NdYV9jqJTPN8qHFgJidxVJSWnisEHzw==; Original-Received: from tomas by mail.tuxteam.de with local (Exim 4.80) (envelope-from ) id 1jxo5f-0000IO-FY for emacs-devel@gnu.org; Tue, 21 Jul 2020 10:57:35 +0200 Content-Disposition: inline In-Reply-To: <69716ecb-8984-23e0-8b44-322ea3582384@yandex.ru> Received-SPF: pass client-ip=5.199.139.25; envelope-from=tomas@tuxteam.de; helo=mail.tuxteam.de X-detected-operating-system: by eggs.gnu.org: First seen = 2020/07/21 04:57:36 X-ACL-Warn: Detected OS = Linux 3.1-3.10 [fuzzy] X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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:253131 Archived-At: --X1bOJ3K7DJ5YkBrT Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Hi, On Tue, Jul 21, 2020 at 04:09:18AM +0300, Dmitry Gutov wrote: [...] I don't think it's intentional, but please reconsider this: > [...] The core of the dispute is whether > project-current's docstring should document the return value in > detail (giving an example of built-in project instances's > structure). Eli is insisting on it because (AFAICT) that suits his > thought process and he thinks that will help users/clients to make > sense of how things work. in a few words: Eli's thought process vs... > I am adamantly against this because it's against the design (clients > should program against the public interface, not against the > implementation), and is likely to encourage incorrect programs. ... The Right Way To Do It (TM). It comes across as a little... biased. Which is understandable, but not a good position when bargaining, nevertheless ;-) Cheers -- t --X1bOJ3K7DJ5YkBrT Content-Type: application/pgp-signature; name="signature.asc" Content-Description: Digital signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.12 (GNU/Linux) iEYEARECAAYFAl8Wrf8ACgkQBcgs9XrR2kaz7gCfWKlGTsIhP000RXzIaQYX8hNN YqcAn2sgPcvlmhnyufspYfBRowxfkhVU =KrbX -----END PGP SIGNATURE----- --X1bOJ3K7DJ5YkBrT--