From: Luis Felipe <luis.felipe.la@protonmail.com>
To: Zelphir Kaltstahl <zelphirkaltstahl@posteo.de>
Cc: guile-user@gnu.org
Subject: Re: Indentation with inline comments in Emacs
Date: Mon, 18 Apr 2022 14:05:34 +0000 [thread overview]
Message-ID: <LRgRz8R0gV_fRK15EcpUAYbLrcSsxe3ZTwXLoHiJGxHwtaTN5P2CaU4mfnTbyIE0r60bLPer59iOsU1NIFFFf1uVA7q4D9VkbK6RfT0CV-c=@protonmail.com> (raw)
In-Reply-To: <325eca55-eb2d-7a66-b5b8-9e323e3e9fc4@posteo.de>
[-- Attachment #1.1: Type: text/plain, Size: 1134 bytes --]
On Monday, April 18th, 2022 at 10:48 AM, Zelphir Kaltstahl <zelphirkaltstahl@posteo.de> wrote:
> I like the documentation style in the doc string you are proposing. Not sure I
> will always go to that length myself, but it would probably be a good practice.
> Just like you said, for generating auto-generating things like API docs. Btw.:
> What is the standard tool in the Guile ecosystem to do that from doc strings
> like yours?
None that I know of :)
But I see there are pieces around that could make it possible to generate documentation [semi]automatically:
+ procedure-documentation
(https://www.gnu.org/software/guile/manual/guile.html#Procedure-Properties)
+ (scheme documentation) module from guile-lib
(https://www.nongnu.org/guile-lib/doc/ref/scheme.documentation/)
+ (ice-9 documentation) module
(https://git.savannah.gnu.org/cgit/guile.git/tree/module/ice-9/documentation.scm)
+ guild doc-snarf command
(although this one doesn't generate any output when passing a module with docstrings)
> Also thanks for the C-c C-d C-d hint. I did not know the shortcut.
You're welcome :)
[-- Attachment #1.2: publickey - luis.felipe.la@protonmail.com - 0x12DE1598.asc --]
[-- Type: application/pgp-keys, Size: 1815 bytes --]
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 509 bytes --]
next prev parent reply other threads:[~2022-04-18 14:05 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-16 12:12 Indentation with inline comments in Emacs Zelphir Kaltstahl
2022-04-16 14:57 ` Jérémy Korwin-Zmijowski
2022-04-17 10:49 ` Zelphir Kaltstahl
2022-04-17 13:44 ` Luis Felipe
2022-04-18 10:48 ` Zelphir Kaltstahl
2022-04-18 13:33 ` Ricardo G. Herdt
2022-04-18 14:09 ` Luis Felipe
2022-04-18 14:05 ` Luis Felipe [this message]
2022-04-17 3:03 ` Taylan Kammer
2022-04-17 11:06 ` Zelphir Kaltstahl
2022-04-17 14:58 ` Maxime Devos
2022-04-18 10:49 ` Zelphir Kaltstahl
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='LRgRz8R0gV_fRK15EcpUAYbLrcSsxe3ZTwXLoHiJGxHwtaTN5P2CaU4mfnTbyIE0r60bLPer59iOsU1NIFFFf1uVA7q4D9VkbK6RfT0CV-c=@protonmail.com' \
--to=luis.felipe.la@protonmail.com \
--cc=guile-user@gnu.org \
--cc=zelphirkaltstahl@posteo.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).