[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: procedure docstrings / documentation
From: |
Matt Wette |
Subject: |
Re: procedure docstrings / documentation |
Date: |
Sat, 23 Sep 2017 16:11:58 -0700 |
> On Sep 23, 2017, at 1:56 PM, Christopher Howard <address@hidden> wrote:
>
> 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/
I don't know of any. Maybe look at examples under .../share/guile/2.2/.