Re: procedure docstrings / documentation

2017-09-26 Thread tantalum
it is available in procedure properties https://www.gnu.org/software/guile/manual/html_node/Procedure-Properties.html i just noticed again that the procedure to get the arguments is undocumented. Scheme Procedure: procedure-arguments proc Scheme Procedure: procedure-documentation proc

Re: procedure docstrings / documentation

2017-09-25 Thread Christopher Howard
On Sun, 2017-09-24 at 00:47 +, tantalum wrote: > * i don't repeat the procedure name and parameter names because that > can  > be queried at run-time or automatically extracted > On this particular point: how do you query the parameter names at run- time? Or do those have to be extracted

Re: procedure docstrings / documentation

2017-09-24 Thread Arne Babenhauserheide
Christopher Howard writes: > 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?

Re: procedure docstrings / documentation

2017-09-23 Thread tantalum
i don't know of common conventions, but here is what i do: * i don't repeat the procedure name and parameter names because that can be queried at run-time or automatically extracted * most of the time i write a type signature in the first line of docstrings because i find that information

Re: procedure docstrings / documentation

2017-09-23 Thread Matt Wette
> On Sep 23, 2017, at 1:56 PM, Christopher Howard > 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

Re: procedure docstrings / documentation

2017-09-23 Thread Christopher Howard
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? > >

procedure docstrings / documentation

2017-09-20 Thread Christopher Howard
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