From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: [Emacs-diffs] master 2475687: Improve documentation changes of a recent commit Date: Mon, 15 Apr 2019 19:06:04 +0300 Message-ID: <83d0lni783.fsf@gnu.org> References: <20190413070933.31645.83730@vcs0.savannah.gnu.org> <20190413070934.DDF7B202C6@vcs0.savannah.gnu.org> <835zrgk5ur.fsf@gnu.org> <09715d71-19d0-fe94-f819-581e89078d84@yandex.ru> <83ftqjiaf6.fsf@gnu.org> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="51108"; mail-complaints-to="usenet@blaine.gmane.org" Cc: emacs-devel@gnu.org To: Dmitry Gutov Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 15 18:07:26 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1hG48g-000D5z-4e for ged-emacs-devel@m.gmane.org; Mon, 15 Apr 2019 18:07:22 +0200 Original-Received: from localhost ([127.0.0.1]:52658 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hG48e-0007aY-Q8 for ged-emacs-devel@m.gmane.org; Mon, 15 Apr 2019 12:07:20 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:51905) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hG47c-0007YO-Tq for emacs-devel@gnu.org; Mon, 15 Apr 2019 12:06:17 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:58773) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hG47b-0003QG-VK; Mon, 15 Apr 2019 12:06:16 -0400 Original-Received: from [176.228.60.248] (port=1039 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1hG47Y-00048S-JZ; Mon, 15 Apr 2019 12:06:13 -0400 In-reply-to: (message from Dmitry Gutov on Mon, 15 Apr 2019 18:42:50 +0300) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:235490 Archived-At: > Cc: emacs-devel@gnu.org > From: Dmitry Gutov > Date: Mon, 15 Apr 2019 18:42:50 +0300 > > Speaking of routine maintenance, since you're asking for documentation > changes together with the patches now, it might be worth it to > standardize the approach more. I usually convey that through review comments, as much as "standardize" is attainable when talking about something like our documentation, which is basically slightly formalized free text. > It's not like I disagree with the whole commit altogether. That part > could be improved. But "refer to that other docstring for the > description of the optional keyword arguments" is something that made > sense to me. Enumerating all the possible return types in just one place > is another thing. I cannot convince you, but I do feel that my change was for the better. Just trust me on that, OK?