From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Panicz Maciej Godek Newsgroups: gmane.lisp.guile.user Subject: Re: docstrings in the reference manual Date: Tue, 16 Dec 2014 07:50:15 +0100 Message-ID: References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=f46d043be12c77394b050a4fc5b5 X-Trace: ger.gmane.org 1418712639 19573 80.91.229.3 (16 Dec 2014 06:50:39 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 16 Dec 2014 06:50:39 +0000 (UTC) Cc: guile-user To: jamil egdemir Original-X-From: guile-user-bounces+guile-user=m.gmane.org@gnu.org Tue Dec 16 07:50:34 2014 Return-path: Envelope-to: guile-user@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Y0lxq-0000MM-KQ for guile-user@m.gmane.org; Tue, 16 Dec 2014 07:50:34 +0100 Original-Received: from localhost ([::1]:43315 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0lxq-0005u0-7Q for guile-user@m.gmane.org; Tue, 16 Dec 2014 01:50:34 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:41546) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0lxa-0005pZ-Jc for guile-user@gnu.org; Tue, 16 Dec 2014 01:50:19 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Y0lxY-0005G3-Sl for guile-user@gnu.org; Tue, 16 Dec 2014 01:50:18 -0500 Original-Received: from mail-wi0-x230.google.com ([2a00:1450:400c:c05::230]:33960) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0lxY-0005Fr-LK for guile-user@gnu.org; Tue, 16 Dec 2014 01:50:16 -0500 Original-Received: by mail-wi0-f176.google.com with SMTP id ex7so11182038wid.9 for ; Mon, 15 Dec 2014 22:50:15 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type; bh=FZMEZpPYpNMtgLibx2fTZs6Wk5nSH7fTXPQhQSHT2LY=; b=ApL3xfIg3H1drxF1ylv3kijy1s7MAxraxI7KG5FLPWrHuPcIq3K6xYDqvBcPnLK1wK tzAKebYfJkpjRyDwLyM5wN1IBwr/SiFE+VJ4dFegNdl0U3s8p8bVa1tUoM2B3ghF87oS bejZReBLjEi8HzqZLD/tnmL6JiPP55CTJ4/OR3SCLJcB6jHE6WcfO2mUOvkQ4Rl5EP4/ x8weZL8Z71WTA5WpTRvMlHH6KkxpakI9VJ9ls+x1i7+AJQy4cFPSzFrMo/v4j9XJaOCR e8JdamtDYFFwR1tyik345ETujGajm8Zr3l+NxPyZU5Qqn/+o/KJowrBTwN50kME5eZSS qd1Q== X-Received: by 10.181.13.106 with SMTP id ex10mr1988513wid.36.1418712615170; Mon, 15 Dec 2014 22:50:15 -0800 (PST) Original-Received: by 10.194.102.38 with HTTP; Mon, 15 Dec 2014 22:50:15 -0800 (PST) In-Reply-To: X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2a00:1450:400c:c05::230 X-BeenThere: guile-user@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: General Guile related discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-user-bounces+guile-user=m.gmane.org@gnu.org Original-Sender: guile-user-bounces+guile-user=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.user:11673 Archived-At: --f46d043be12c77394b050a4fc5b5 Content-Type: text/plain; charset=UTF-8 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 > 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. --f46d043be12c77394b050a4fc5b5 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable
Hello jamil

2014-12-15 23:48 GMT+01:00 jamil egdemir <unclejamil@g= mail.com>:
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.=C2=A0 When I say docstring here I'm think= ing
of docstrings like we have in python.

It is= described here:

=C2=A0 =C2=A0 =C2= =A0Return the documentation string associated with `proc'.=C2=A0 By
=C2=A0 =C2=A0 =C2=A0convention, if a procedure contains more than on= e expression and
=C2=A0 =C2=A0 =C2=A0the first expression is a st= ring constant, that string is assumed
=C2=A0 =C2=A0 =C2=A0to cont= ain documentation for that procedure.

I agre= e 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 t= o contain documentation for that procedure (so-called 'docstring')&= quot;), to make it easier to find, and that there should be a "docstri= ng" index entry as well.

--f46d043be12c77394b050a4fc5b5--