From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id uEPSE1anZGMDIwAAbAwnHQ (envelope-from ) for ; Fri, 04 Nov 2022 06:47:02 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id GD/lE1anZGNbEwAA9RJhRA (envelope-from ) for ; Fri, 04 Nov 2022 06:47:02 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id DE4193B3C3 for ; Fri, 4 Nov 2022 06:47:01 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oqpWh-0003hT-8F; Fri, 04 Nov 2022 01:45:59 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oqpWc-0003gL-CT for emacs-orgmode@gnu.org; Fri, 04 Nov 2022 01:45:55 -0400 Received: from mail.tuxteam.de ([5.199.139.25]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oqpWZ-0006wa-Vh for emacs-orgmode@gnu.org; Fri, 04 Nov 2022 01:45:53 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tuxteam.de; s=mail; h=From:In-Reply-To:Content-Type:MIME-Version:References:Message-ID: Subject:To:Date:Sender:Reply-To:Cc:Content-Transfer-Encoding:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=MY7FT24Pi8gSj7+dQbd2HZwMcLKmlj9GDO4xIMfG+64=; b=CUAVjoBMLBuk8uGeyXOMJqmvKG /GFq+ZD3QTZvfUVv8H2cuC3EW01qstYsl/oL5gpz8+CTBJ/r9jRoxXfpDqYaAzhuTVl+mn//eWMsd vMHkAW+dMkBpkn8LdiEkGG7oOpgKd1+y9htccYd+/HGY8kBBmxeFvprqkM8qCkdyhAzFUIjqued8O un/8aJ0GOQYFFvWfsiwyPnolo+1FVni7HoY2FfLOIremsJIyEaRndZNOk7ntVu0ed7FdqomQzHSjv gRRaXhfdYw0eX5d9pHM5NPdymUKR5OmWTy8J69iEe65Wzu1qmwZj4dnkSZOg99Kl+YFwxT27W9BxJ skpwVB+A==; Received: from tomas by mail.tuxteam.de with local (Exim 4.94.2) (envelope-from ) id 1oqpWX-0002qh-QY for emacs-orgmode@gnu.org; Fri, 04 Nov 2022 06:45:49 +0100 Date: Fri, 4 Nov 2022 06:45:49 +0100 To: emacs-orgmode@gnu.org Subject: Re: Docstrings and literate programming (good practices?) Message-ID: References: <87bkpqbwef.fsf@posteo.net> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="9fkIW0KO6E4pr3jo" Content-Disposition: inline In-Reply-To: From: Received-SPF: pass client-ip=5.199.139.25; envelope-from=tomas@tuxteam.de; helo=mail.tuxteam.de X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "Emacs-orgmode" Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1667540822; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=MY7FT24Pi8gSj7+dQbd2HZwMcLKmlj9GDO4xIMfG+64=; b=fN5xFhtT4edLajOf8W8q/KBnkP90wgLL4kKY4udplesRG3LE+z4lEhOvvAShjdh4l4tnMx s0MfyLpT3UBICYlw9fQFj6c8RnMnlga69uGGunP8Qu+t6+5EtEhARFosbJNvyzgDNXVp6E ttzvCYVyIIyF3657CLfG6dEVOpmQdD8NO0NBDygrdw/1YU3LPabUDDott/jk8hUyP/RDro JrblbjbFAGq06CuIDP7gFKnwxg/cucz3jP102vFDuJm6/Hv+ezm/slHt7TucJoi9BHqgFB rmRWmgHYPea4E9uCnB2qNpHyL6/qY1P7Ybz2XBsMAfsXH1N9m8Krt4Iuz499RA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1667540822; a=rsa-sha256; cv=none; b=A308TlOELy+bZfTLjG4gMK/xz0bHiAZMCTaxnhJH4VktqR+LqDji4Ny6F/FJ57iEF4gktK 5cW60jOBfrcds6XwAQjyk2ZxznBupfUX+YDWzl1krgKB3yYgYd8SSBgup6KnzARJssHmGL agUE0mjgE6dKqMb6BKqr7tb3DGXUbM23s3fGrZqlWhe6RdN7GLeyOkeyBkNwlzg3dAiEAx iMVl0qKKyNyKBAOpsTOSsrM79Izha35Susoe8GdcMWlfKR0fdEHqSf7qY/hj+M8H8kHW+j 0AY+VfgItEB/2pSQNdRcplj2MO5AVyASS4Lyx5dmexBZhENO+ZTZefSmNOlkog== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=tuxteam.de header.s=mail header.b=CUAVjoBM; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -1.40 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=tuxteam.de header.s=mail header.b=CUAVjoBM; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: DE4193B3C3 X-Spam-Score: -1.40 X-Migadu-Scanner: scn0.migadu.com X-TUID: 7ccK7f7LfUvR --9fkIW0KO6E4pr3jo Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Nov 03, 2022 at 08:03:05PM -0700, Samuel Wales wrote: > i wonder if emacs or org has what you might call semi-literate or > etaretil docstring functions? >=20 > for example, you have a body of non-literate elisp code, and you have > a manual. it could be redundant to describe commands and what they do > and their options, if the docstrings are good. >=20 > why not include the docstrings of all commands in some nice format in > the .org manual via some mechanism? Ah. Javadoc and their descendants. I tend to call that "illiterate programming"... > would that be a good practice? seems useful abstractly. =2E.. but I might be biased. I tend to detest its results. Especially composed with languages having compulsive type declarations. Cheers --=20 t --9fkIW0KO6E4pr3jo Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iF0EABECAB0WIQRp53liolZD6iXhAoIFyCz1etHaRgUCY2SnBwAKCRAFyCz1etHa RrZOAJ4hfE5DEXDnkVoyUWgSO+0StzmqGQCaAjj9DOYV4u2bKG+z4c7WWwoWRa8= =J2u1 -----END PGP SIGNATURE----- --9fkIW0KO6E4pr3jo--