From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id 6CHoF0PSZGPHlgAAbAwnHQ (envelope-from ) for ; Fri, 04 Nov 2022 09:50:11 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id aAfiF0PSZGPYnQAAauVa8A (envelope-from ) for ; Fri, 04 Nov 2022 09:50:11 +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 16C3F3EFD3 for ; Fri, 4 Nov 2022 09:50:10 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oqsNg-00015U-Kd; Fri, 04 Nov 2022 04:48:57 -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 1oqsNL-00011H-OY for emacs-orgmode@gnu.org; Fri, 04 Nov 2022 04:48:33 -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 1oqsNJ-0005bx-DZ for emacs-orgmode@gnu.org; Fri, 04 Nov 2022 04:48:31 -0400 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 8777F240103 for ; Fri, 4 Nov 2022 09:48:25 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1667551707; bh=Zh2lsm3YT+kjB6PSaWyEAovmPCnb7OsWvXjpsTKucx4=; h=From:To:Cc:Subject:Date:From; b=EIinihSu7s32TPQ1oiQjLzB4SIjdxtcJlWKSsqiZgagNHR5/ppgj3uC49Ju3xluS4 /HrUECLym9WXs37rlKVgmjWryT9RRRw25iNYkS9lLCHMDfscpSlRm+2Q7sJ9AYAT5V pOPI5K8QYc59YeY1rCqmtOC0TCJOZx9wMXno3p6bPXqfCDYbIZW94rhSnGS5gn+dh2 o1nG3hCMQ+EdStUFwa2HdPPLCL9LxpRvJi3pclDQoZ8VK71b2aWtmwcL/wV4zkAgIn 9VX2W6sSpqOKPNops78Za/HwY1ypmwcf2S7UVwFT2f1cONXa3qozSM56r6I1BisVt9 0QO7fnhLMWraQ== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4N3Z5z59Qcz6tnv; Fri, 4 Nov 2022 09:48:23 +0100 (CET) From: Ihor Radchenko To: Samuel Wales Cc: Rudolf =?utf-8?Q?Adamkovi=C4=8D?= , Juan Manuel =?utf-8?Q?Mac=C3=ADas?= , orgmode Subject: Re: Docstrings and literate programming (good practices?) In-Reply-To: References: <87bkpqbwef.fsf@posteo.net> Date: Fri, 04 Nov 2022 08:49:04 +0000 Message-ID: <87fsezgl4v.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: -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, RCVD_IN_DNSWL_NONE=-0.0001, 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=1667551811; 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=85EyQz2bz8kiConWOwvPRZtVX1gMtttbzn5AsTK+UaI=; b=AIomdg3D4fWp98Cljjfw046pJ3Wr8qaUzkQ3Zi6HAhliz2kERLCuY9vwgH13OLe2KSfA3g 1hBpPYDypZWBtLwUBTqbQgoh+dulGdbBKZNrFkmidibGGNJIoIilseYB71wZSuAn+SDA9G b5aGaIYGoq98zKhWznjaYq39MLw7IF7nNeEvuU3J1zw+K8ykI9ylimaVcUmwOtrLkSHicj mDLs5Hjh4QxTwjAXho/1WIeB3AAUCLG7V73ofXTgexUHb1wSp5wF9OIbcD+ikVOovgLhFJ 9DO9yAVN2JvIFtVmEWXUXAZ6gwFP7DxseG7DQIITgc0PslbCcLsJf96A4mTiAA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1667551811; a=rsa-sha256; cv=none; b=G4tG7+NuCF7l/eH2Q72XEuqi9XwC89egLQfRnckLSScaVSWxhhmkAdZBcvkA+iJ0xB5aWc KUC6K5Hpk1K8jM8VtWwubax2uzQjMMP6gJIdMAD+uUKmxdTdvrBP7m/xVmRUvaMt1iCEpB icbxnvubqdWKFyLcjeEm0kqQxyqccEFLG5zWT7h3GKS4oZrjfxoOkbr5z/odigVlmTk7ZJ qWLeg6PremxkJdKzKq/GDoIYd0JYlBTHEgbciPXixsJOKMmh0MrEkS+L8/vMC2ErV5gajC rJRhPINAZVTT+ispQSWePXyNI6NPcrLvgZ2OhXP1ip7ei/w+otNDM5u1bAR8Tg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=EIinihSu; 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: -3.70 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=EIinihSu; 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: 16C3F3EFD3 X-Spam-Score: -3.70 X-Migadu-Scanner: scn1.migadu.com X-TUID: dMp4054nBeme Samuel Wales writes: > why not include the docstrings of all commands in some nice format in > the .org manual via some mechanism? > > would that be a good practice? seems useful abstractly. There are two problems: 1. We need to convert from Elisp docstring format to Org markup 2. More importantly, User manual is something to be written as a coherent text; not an agglomeration of docstring. (Yes, I am aware of the fact that it is not always the case in practice; But we should not encourage the current situation) -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at