From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Mirko Newsgroups: gmane.emacs.help Subject: Re: hideshow docstring in elisp or common lisp code Date: Thu, 8 Nov 2018 05:57:04 -0800 (PST) Message-ID: <917d89da-2bea-4f67-b820-9b670632e84b@googlegroups.com> References: <86o9b2auxh.fsf@zoho.eu> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" X-Trace: blaine.gmane.org 1541685514 29852 195.159.176.226 (8 Nov 2018 13:58:34 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 8 Nov 2018 13:58:34 +0000 (UTC) Injection-Date: Thu, 08 Nov 2018 13:57:05 +0000 User-Agent: G2/1.0 To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Thu Nov 08 14:58:30 2018 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gKkpI-0007ar-UA for geh-help-gnu-emacs@m.gmane.org; Thu, 08 Nov 2018 14:58:29 +0100 Original-Received: from localhost ([::1]:56923 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gKkrP-000467-AA for geh-help-gnu-emacs@m.gmane.org; Thu, 08 Nov 2018 09:00:39 -0500 X-Received: by 2002:a24:5495:: with SMTP id t143-v6mr1017454ita.34.1541685425382; Thu, 08 Nov 2018 05:57:05 -0800 (PST) X-Received: by 2002:a37:4946:: with SMTP id w67-v6mr55477qka.5.1541685425012; Thu, 08 Nov 2018 05:57:05 -0800 (PST) Original-Path: usenet.stanford.edu!g188-v6no470062itg.0!news-out.google.com!n199-v6ni746itn.0!nntp.google.com!g188-v6no470058itg.0!postnews.google.com!glegroupsg2000goo.googlegroups.com!not-for-mail Original-Newsgroups: gnu.emacs.help In-Reply-To: <86o9b2auxh.fsf@zoho.eu> Complaints-To: groups-abuse@google.com Original-Injection-Info: glegroupsg2000goo.googlegroups.com; posting-host=208.218.238.20; posting-account=yS7ZzQoAAACbDncxMo9UeCyhsLtcDWPM Original-NNTP-Posting-Host: 208.218.238.20 Original-Xref: usenet.stanford.edu gnu.emacs.help:224467 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.org gmane.emacs.help:118596 Archived-At: On Tuesday, November 6, 2018 at 2:05:17 PM UTC-5, Emanuel Berg wrote: > Mirko Vukovic wrote: > > > I would like to hide/show docstrings of my > > common lisp code. > > Sorry for a non-answer, but why do you want to > do that? Instead, practice to write really > short and to-the-point instructions :) > > There are formal rules, which are good to stick > to. Probably you are aware of them, and the > facilities to formally check the formalities, > but I tell you/everyone else anyway how to do > it: > > (defun check-package-style () > (interactive) > (checkdoc-current-buffer t) ; TAKE-NOTES > (message "Style check done.") ) > > Good luck! > > -- > underground experts united > http://user.it.uu.se/~embe8573 Emanuel, First thanks for pointing to checkdoc. I was not aware of it. My intent is to keep the function's documentation close to the function itself. For my Common Lisp code I follow the layout used in the official documentation (the Hyperspec), which while verbose, starts with a single line brief explaining the function. Hideshow on that would work very nicely on that convention. One benefit (for me) is the documentation generator (HeLambdaP) that parses the lisp file and the docstring, and generates the html documentation straight from the docstring. To summarize: - keeping documentation close to the code makes maintenance easy - Following hyperspec convention allows for generation of html documentation. Mirko