From: Christopher Howard <christopher.howard@qlfiles.net>
To: Guile User Mailing List <guile-user@gnu.org>
Subject: Re: procedure docstrings / documentation
Date: Sat, 23 Sep 2017 12:56:13 -0800 [thread overview]
Message-ID: <1506200173.29597.2.camel@qlfiles.net> (raw)
In-Reply-To: <1505953100.1041.2.camel@qlfiles.net>
[-- Attachment #1: Type: text/plain, Size: 617 bytes --]
No thoughts related to this subject?
On Wed, 2017-09-20 at 16:18 -0800, Christopher Howard wrote:
> Is there any convention on content/formatting for a procedure
> docstring? E.g., should I repeat the procedure name and arguments?
> Should I insert newlines to maintain a certain text width?
>
> I'm not really clear on how document is done in Guile, overall. I see
> Gieser has ways to look up documention for some procedures/modules,
> but
> it doesn't seem to pull that information from the docstring, at least
> not my docstrings.
>
--
https://qlfiles.net
https://emailselfdefense.fsf.org/en/
[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
next prev parent reply other threads:[~2017-09-23 20:56 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-21 0:18 procedure docstrings / documentation Christopher Howard
2017-09-23 20:56 ` Christopher Howard [this message]
2017-09-23 23:11 ` Matt Wette
2017-09-24 6:49 ` Arne Babenhauserheide
-- strict thread matches above, loose matches on Subject: below --
2017-09-24 0:47 tantalum
2017-09-25 14:01 ` Christopher Howard
2017-09-26 9:32 ` tantalum
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=1506200173.29597.2.camel@qlfiles.net \
--to=christopher.howard@qlfiles.net \
--cc=guile-user@gnu.org \
/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).