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 kJW7HtRJYmOwJQEAbAwnHQ (envelope-from ) for ; Wed, 02 Nov 2022 11:43:32 +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 2OjAHtRJYmPgKQAA9RJhRA (envelope-from ) for ; Wed, 02 Nov 2022 11:43:32 +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 1804211986 for ; Wed, 2 Nov 2022 11:43:32 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oqBCp-0000Dx-3L; Wed, 02 Nov 2022 06:42:47 -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 1oqBCm-0000Ad-0n for emacs-orgmode@gnu.org; Wed, 02 Nov 2022 06:42:44 -0400 Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oqBCk-00015s-2E for emacs-orgmode@gnu.org; Wed, 02 Nov 2022 06:42:43 -0400 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 49513240105 for ; Wed, 2 Nov 2022 11:42:40 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1667385760; bh=QvrJQJFdfKTrUAcjlgvireWUqd3NK14dIofrCY1Ovks=; h=From:To:Cc:Subject:Date:From; b=mNFRwpDg+I6kZIH1lhOiGExvwRT/AsBm3zy0YyNUOJtlpX5M60YU/0oHGbIsQzZNk muVfVWaP/Rd2HqRdpSjR6qHWKQhmaa9R+lbe9iYIl9y2dRV8zxpSG38OXJHVv0QdYD ws6AvWtjb+aou5F0m9O6J9g77PGHCfvdaPnAzlFtgZ5lLFp76BGOLPN+mikAdKUPIp 1Cl7ZPDgN03lKtsz29q2ou69rAZt3/73PNEWCKW6D7GIsXMviX+0caH+HPdgiJwxFC A8eizC4b8fO17uIALCh7Y9MKpjgl5HQjlQ4CLOXYWr0Kte/Z+RvW5cLeI6hze1JW53 l/aO5VR7GmTfw== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4N2Nkl056dz6tnp; Wed, 2 Nov 2022 11:42:38 +0100 (CET) From: Ihor Radchenko To: "Dr. Arne Babenhauserheide" Cc: Juan Manuel =?utf-8?Q?Mac=C3=ADas?= , emacs-orgmode@gnu.org Subject: Re: Docstrings and literate programming (good practices?) In-Reply-To: <87r0ylvlh9.fsf@web.de> References: <87bkpqbwef.fsf@posteo.net> <87v8nxkewc.fsf@localhost> <87r0ylvlh9.fsf@web.de> Date: Wed, 02 Nov 2022 10:43:20 +0000 Message-ID: <87fsf1k56f.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.66; envelope-from=yantar92@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H2=-0.001, 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=1667385812; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=LhXA7XneB8svU1kFKMIGgUVD4g03m93voRTcC646FJc=; b=TZrG1IPg3rfHjH4CWg9uwfUD6s+kdcZkONfjLhbQBc8sn+gnWRUmH2MeNd3Jnc7/FLgxZy gLfyABVXw3lHjA5c2AgrFx8sylikYOp0O3PpSYcXmbQagndfuER/uXhp2TgpH86sPf9wLW HNJyWfu/Xam1kpkfUP36wuEz+Lqc/beBAC0sqvrQuqeFY8NWzjFjZJdeslpeg/e2M/VchS alrQciKQFfiLjfhBM9/Gg1jhrWI9KQ3MBVx5KHJ3R0mqfDqfdLdp6Wzw9dZFja5kMNn77a 8e8oDiRRj0Z0fL8vjFu5umS/jMP1I9IvekBoDPW8e9R2dptRUhHQ1MgCkmez1w== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1667385812; a=rsa-sha256; cv=none; b=Q7i1BU3tmKKU6VX+bi/zfgRC4jdvt9TETdIVhIeULDzpKPQRqxPEpLEuT+8GvR6JrU/2tP 63+nSnnIVSROWCRAjnYifK0I3V7thXQONkKlIy/aLrz2xr9EsdgcjCGrbRyfv/s7wBsrFF Nx6xqENJEa4YATC1Ep+nRat7EdagWwCBSzAikMX9+vOJ5uY87MYxVHe9Hc93fAB7pufv8O PZcB95P6HJzsB96hY/dDkrexGN7d0Oc+TXfpIrWXLirAd/UFHr7KaUb/Bphsgn3UsQdNdY yt77q9MLSe+eTW/uP4kL+tu+V2teue8FY9pO0qhOphi8nyUy0p8M04KfiS4OLw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=mNFRwpDg; dmarc=pass (policy=none) header.from=posteo.net; 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: -5.28 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=mNFRwpDg; dmarc=pass (policy=none) header.from=posteo.net; 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: 1804211986 X-Spam-Score: -5.28 X-Migadu-Scanner: scn0.migadu.com X-TUID: IOlpKDQvB0Pj "Dr. Arne Babenhauserheide" writes: > The first (org-block) for long-form text (like official javadoc), the > second (just verbatim) for shorter docstrings. For even shorter docstrings, you can just #+name a paragraph. -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at