From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Emanuel Berg via "Emacs development discussions." Newsgroups: gmane.emacs.devel Subject: Re: Some ideas with Emacs Date: Sun, 01 Dec 2019 04:21:13 +0100 Message-ID: <86v9r0spcm.fsf@zoho.eu> References: <837e3iq0ks.fsf@gnu.org> <87h82my0fm.fsf@gmx.de> Reply-To: Emanuel Berg Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="201849"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Dec 01 04:21:38 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.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1ibFnm-000qPQ-JD for ged-emacs-devel@m.gmane.org; Sun, 01 Dec 2019 04:21:38 +0100 Original-Received: from localhost ([::1]:40260 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibFnl-0001tN-EH for ged-emacs-devel@m.gmane.org; Sat, 30 Nov 2019 22:21:37 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:45458) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibFnf-0001tF-CR for emacs-devel@gnu.org; Sat, 30 Nov 2019 22:21:32 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ibFne-00034V-81 for emacs-devel@gnu.org; Sat, 30 Nov 2019 22:21:31 -0500 Original-Received: from 195-159-176-226.customer.powertech.no ([195.159.176.226]:36056 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ibFne-00033R-1H for emacs-devel@gnu.org; Sat, 30 Nov 2019 22:21:30 -0500 Original-Received: from list by blaine.gmane.org with local (Exim 4.89) (envelope-from ) id 1ibFnW-000qA2-Kw for emacs-devel@gnu.org; Sun, 01 Dec 2019 04:21:22 +0100 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: emacs-devel@gnu.org Mail-Copies-To: never Cancel-Lock: sha1:IglApIbsKlwI65miEaYpfRIxdjk= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 195.159.176.226 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.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:242932 Archived-At: Michael Albinus wrote: > Personally, I don't like docstring to be too > verbose. [...] But if one puts the concise stuff topmost? Then you can read that, and go on typing in a heartbeat? And those who like verbose docstrings can keep on reading :) Docstrings is where I look all the time. There are rules what should be mentioned and in what order. Those rules makes total sense. Stick to them and have it concise first thing. But after that, if anyone wants to write several screens of quality documentation exploring every aspect of the topic, do it :) -- underground experts united http://user.it.uu.se/~embe8573 https://dataswamp.org/~incal