Re: docstrings in the reference manual

[Panicz Maciej Godek]

Hello jamil

2014-12-15 23:48 GMT+01:00 jamil egdemir <address@hidden>:

Hi,

I'm almost afraid to ask this one but I've been poking around the
reference manual at:

https://www.gnu.org/software/guile/manual/html_node/index.html

for a while now and for the life of me I can't find a description of
how docstrings work in guile.  When I say docstring here I'm thinking
of docstrings like we have in python.

It is described here:

https://www.gnu.org/software/guile/manual/html_node/Procedure-Properties.html (the "procedure-documentation" entry):

     Return the documentation string associated with `proc'.  By

     convention, if a procedure contains more than one _expression_ and

     the first _expression_ is a string constant, that string is assumed

     to contain documentation for that procedure.

I agree though that it can be difficult to find, and it would be a bit better if it used the word "docstring" (like "that string is assumed to contain documentation for that procedure (so-called 'docstring')"), to make it easier to find, and that there should be a "docstring" index entry as well.