From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: jamil egdemir Newsgroups: gmane.lisp.guile.user Subject: Re: docstrings in the reference manual Date: Tue, 16 Dec 2014 15:16:55 -0500 Message-ID: References: <20141216114248.GA4960@intra> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 X-Trace: ger.gmane.org 1418761036 2525 80.91.229.3 (16 Dec 2014 20:17:16 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 16 Dec 2014 20:17:16 +0000 (UTC) To: guile-user Original-X-From: guile-user-bounces+guile-user=m.gmane.org@gnu.org Tue Dec 16 21:17:11 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 1Y0yYP-00084k-OE for guile-user@m.gmane.org; Tue, 16 Dec 2014 21:17:09 +0100 Original-Received: from localhost ([::1]:46705 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0yYO-0003Xp-Rk for guile-user@m.gmane.org; Tue, 16 Dec 2014 15:17:08 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58157) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0yYD-0003XS-Uh for guile-user@gnu.org; Tue, 16 Dec 2014 15:16:58 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Y0yYC-0004Vl-Ig for guile-user@gnu.org; Tue, 16 Dec 2014 15:16:57 -0500 Original-Received: from mail-wg0-x230.google.com ([2a00:1450:400c:c00::230]:50849) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Y0yYC-0004Vf-DI for guile-user@gnu.org; Tue, 16 Dec 2014 15:16:56 -0500 Original-Received: by mail-wg0-f48.google.com with SMTP id y19so18444532wgg.35 for ; Tue, 16 Dec 2014 12:16:55 -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 :content-type; bh=LXUrQZZogrxTphgOZAxX1ASkXcZihuvYQ0qCND1B4uA=; b=aP8HQ37tfqmNpYXeVGpP21ksWL/7gMoOvsX/MZF/8os8LsWnr+C2+dOVZNwP87SOfh YCGp+JudpdTwJFGcuxN42ixlCIRsdgFql4rOtIl5umn37VngSL9tf6boXNCq3OE9eHZr HTnkZTrdO3XiEIe1E8D38rKnv4LV3PSTK1uVO0YbpCHmN3oq3XJ5zkWakG7Sfb/hUKpw h3Ry+zLb1EQK6NNYDJDhEjmz5uVWJ/VgqjtQyLyoPvMPrkQstU60aQV8kfZ8IoQKG1j7 Xds3cAVkgBazE30zRd2U2RtbVxyKNAe9mcc0aJ102ttXyl2/7+p4K757f1WpZcJbtssY 88Nw== X-Received: by 10.180.104.65 with SMTP id gc1mr7715130wib.46.1418761015704; Tue, 16 Dec 2014 12:16:55 -0800 (PST) Original-Received: by 10.27.6.202 with HTTP; Tue, 16 Dec 2014 12:16:55 -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:c00::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:11679 Archived-At: 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 word >> in any >> dictionary. You have made some good points. I guess I'd add a couple more: - The word docstrings is already in use in the reference manual in at least one place: https://www.gnu.org/software/guile/manual/html_node/Function-Snarfing.html - Anyone coming to scheme (at least) from Python is likely to eventually look for docstrings in the index. At one point last night I did and ended up searching through the larger html version of the ref manual on one page for 'docstring' and ended up in the section on function snarfing (mentioned above). That section wasn't quite what I was looking for though it seemed related so I then backed off and searched for 'doc'. This resulted in jillions of hits. Unfortunately I gave up before finding the passage Panicz pointed out. Perhaps 'docstring' has cropped up b/c the word documentation is used so frequently in ref manuals like this that it camouflauges any description of the docstring concept. I'm no expert on these things but perhaps 'docstring' has popped into existence for this reason. -j -- ------------------------------------------------------------- Jamil Egdemir unclejamil@gmail.com http://www.power-quant.com -------------------------------------------------------------