Re: docstrings in the reference manual

2014-12-16 Thread jamil egdemir
John, > 2014-12-16 12:42 GMT+01:00 John Darrington : >> >> Why murder the English language more than necessary? "Docstrings" is a >> cliche >> which has come from other projects. Peope for whom English is not their >> first >> language can be confused by such aliterations. They won't find the w

Re: docstrings in the reference manual

2014-12-16 Thread Panicz Maciej Godek
2014-12-16 12:42 GMT+01:00 John Darrington : > > Why murder the English language more than necessary? "Docstrings" is a > cliche > which has come from other projects. Peope for whom English is not their > first > language can be confused by such aliterations. They won't find the word > in any >

Re: docstrings in the reference manual

2014-12-16 Thread John Darrington
Why murder the English language more than necessary? "Docstrings" is a cliche which has come from other projects. Peope for whom English is not their first language can be confused by such aliterations. They won't find the word in any dictionary. Write the term "documentation string" out in f

Re: docstrings in the reference manual

2014-12-16 Thread Panicz Maciej Godek
> > > > 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"

Re: docstrings in the reference manual

2014-12-16 Thread jamil egdemir
Panicz, On 12/16/14, Panicz Maciej Godek wrote: > 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 c

Re: docstrings in the reference manual

2014-12-15 Thread Panicz Maciej Godek
Hello jamil 2014-12-15 23:48 GMT+01:00 jamil egdemir : > > 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 >

docstrings in the reference manual

2014-12-15 Thread jamil egdemir
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