From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: John Darrington Newsgroups: gmane.lisp.guile.user Subject: Re: docstrings in the reference manual Date: Tue, 16 Dec 2014 12:42:48 +0100 Message-ID: <20141216114248.GA4960@intra> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="k1lZvvs/B4yU6o8G" X-Trace: ger.gmane.org 1418730198 1335 80.91.229.3 (16 Dec 2014 11:43:18 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 16 Dec 2014 11:43:18 +0000 (UTC) Cc: guile-user To: jamil egdemir Original-X-From: guile-user-bounces+guile-user=m.gmane.org@gnu.org Tue Dec 16 12:43:14 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 1Y0qX2-0003hV-13 for guile-user@m.gmane.org; Tue, 16 Dec 2014 12:43:12 +0100 Original-Received: from localhost ([::1]:44203 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0qX1-0000aO-IO for guile-user@m.gmane.org; Tue, 16 Dec 2014 06:43:11 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34230) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0qWo-0000a5-OC for guile-user@gnu.org; Tue, 16 Dec 2014 06:43:02 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Y0qWk-0002zF-Gf for guile-user@gnu.org; Tue, 16 Dec 2014 06:42:58 -0500 Original-Received: from de.cellform.com ([88.217.224.109]:49842 helo=jocasta.intra) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0qWk-0002z2-2Z for guile-user@gnu.org; Tue, 16 Dec 2014 06:42:54 -0500 Original-Received: from muse.intra (muse.intra [192.168.0.6]) by jocasta.intra (8.14.4/8.14.4/Debian-4) with ESMTP id sBGBgn5m014276 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT); Tue, 16 Dec 2014 12:42:49 +0100 Original-Received: from john by muse.intra with local (Exim 4.80) (envelope-from ) id 1Y0qWe-0001Jg-RC; Tue, 16 Dec 2014 12:42:48 +0100 Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.21 (2010-09-15) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 88.217.224.109 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:11676 Archived-At: --k1lZvvs/B4yU6o8G Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Why murder the English language more than necessary? "Docstrings" is a cli= che=20 which has come from other projects. Peope for whom English is not their fi= rst=20 language can be confused by such aliterations. They won't find the word in= any dictionary. Write the term "documentation string" out in full, or simply "documentation= "=20 where the context is clear. J' On Tue, Dec 16, 2014 at 05:54:28AM -0500, jamil egdemir wrote: Panicz, =20 On 12/16/14, Panicz Maciej Godek wrote: > It is described here: > https://www.gnu.org/software/guile/manual/html_node/Procedure-Proper= ties.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 assum= ed > to contain documentation for that procedure. =20 Good eyes! =20 > I agree though that it can be difficult to find, and it would be a b= it > 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 entr= y as > well. =20 I agree. This info on docstrings is tucked away pretty well. I noticed here in the ref man: =20 https://www.gnu.org/software/guile/manual/html_node/Reporting-Bugs.htm= l#Reporting-Bugs =20 that documentation that is unclear is considered a bug (last bullet in the first list). If you think it makes sense then I'll submit a bug on the documentation with this info and your suggestion. =20 -j =20 --=20 ------------------------------------------------------------- Jamil Egdemir unclejamil@gmail.com http://www.power-quant.com ------------------------------------------------------------- --=20 PGP Public key ID: 1024D/2DE827B3=20 fingerprint =3D 8797 A26D 0854 2EAB 0285 A290 8A67 719C 2DE8 27B3 See http://sks-keyservers.net or any PGP keyserver for public key. --k1lZvvs/B4yU6o8G Content-Type: application/pgp-signature; name="signature.asc" Content-Description: Digital signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.12 (GNU/Linux) iEYEARECAAYFAlSQGrcACgkQimdxnC3oJ7MiJACeMBoKt+l506TuePTHj4IF6FDO P2YAmgKQbl8bXGhbL18xA5Ej0y9x5zmh =v052 -----END PGP SIGNATURE----- --k1lZvvs/B4yU6o8G--