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 +DZzKzZwY2MeXwAAbAwnHQ (envelope-from ) for ; Thu, 03 Nov 2022 08:39:34 +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 +K10KzZwY2MwRQAAauVa8A (envelope-from ) for ; Thu, 03 Nov 2022 08:39:34 +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 4FA583899E for ; Thu, 3 Nov 2022 08:39:33 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oqUo0-00055A-S1; Thu, 03 Nov 2022 03:38:29 -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 1oqUnm-00052i-Mn for emacs-orgmode@gnu.org; Thu, 03 Nov 2022 03:38:19 -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 1oqUnh-0001ub-L0 for emacs-orgmode@gnu.org; Thu, 03 Nov 2022 03:38:14 -0400 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 13146240106 for ; Thu, 3 Nov 2022 08:38:06 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1667461087; bh=C7Q47eGMSw+wBtX7y50dtlh/VkRZ1cUkIZjGEjFaL+U=; h=From:To:Cc:Subject:Date:From; b=e1RAIMNzZ/GsbYd5BmYFQdKtVgkS4FWHL5CgnAu7VisrVnXNdG/sCPjuOI5z4kZsq 7pis2H4HV64zrYpwuPEjhg+jQSglUWcj8Vt2wyEO14vNR1JQX3nntmpFOjMC/K/W3D dv6ePFVU86hADo3vpHpT2/MxTK9eHrxT6wnV05xEXBL9sRfzER2P4QKW7+h0RO7oAH uwvZFG1UbhEXvzdq3wYplLNvi8PIfcrVMZwjVDY9d8bVxjV+CCgvThXErozCbCVZza AegZhHYGYyfRl7tx0nhXJJ11bPb9ofHgaVwMy84+vtl/uuI6LbGOHS+Kp+VbpXspwR NU2tfo57PisYg== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4N2wbK5F06z9rxR; Thu, 3 Nov 2022 08:38:05 +0100 (CET) From: Ihor Radchenko To: Juan Manuel =?utf-8?Q?Mac=C3=ADas?= Cc: orgmode Subject: Re: Docstrings and literate programming (good practices?) In-Reply-To: <87bkpp1iyp.fsf@posteo.net> References: <87bkpqbwef.fsf@posteo.net> <87v8nxkewc.fsf@localhost> <87leot1pyv.fsf@posteo.net> <87o7tp8q29.fsf@localhost> <87bkpp1iyp.fsf@posteo.net> Date: Thu, 03 Nov 2022 07:38:46 +0000 Message-ID: <878rks7aih.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable 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_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=1667461174; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=C7Q47eGMSw+wBtX7y50dtlh/VkRZ1cUkIZjGEjFaL+U=; b=vDbj1DwQUSlAnZmSXkGJGTsxSDoMkrU9c18lh31w+oVWMdbTT5AAndc3elwjWh3BzpJnQc qmhodrSi7owCE5iW2rx5ddIFulkWB4KLydI51YMzfsdnbyCKB7jf4mLSab8y78OzeSlRMN 7cclmYifR/kjvVoZr/05e+W1gPsU2C9ACN8cQrFvf4UxhijwSVgckc9/Ualat3CrJgO6ny d7bO8h3pPUnNXJ7A55onqTBFkcNbe4EDo8YbsTH6d9wMouPysTq/2NNGOpyvSHSyo0TK2j gGy81DqppSzwtSP3jSVyiOMN3JLpaWNEqsDNqRLFEoSm4YYz3Xc90KQ29lnZyw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1667461174; a=rsa-sha256; cv=none; b=i554oCs8lA7lcVBsO7QJ4rPXZOHnSxDjGNwwXYeYKVGUe0lYgpeX6gzi87HRfvlhQTPr4X rFy128Hl85Dbz7xEmlK7r5Zn3l8ONH8gfrOnBnpIKLLr53cP8eJH7T8F6CqiMuTlzZFZYJ /8HgOpSesOSHVOYGsztUIW8C5FwBEzp/4wnkTh200Af3OtpGunpUZLWE6+aXHsl+efzxkV /BHFPFdcoFfbl113BKxkyt+GzwvM4BO+Acv1LcSc7PzMEbjaA7oRbpI8Pj1tfn1uBgEZUW QNkQ/VJaOHS9vbI9J2WWVdLGncnHDw5k7rSYgp1+HtjMAQZ882mVKi0yTtmSKQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=e1RAIMNz; 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.49 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=e1RAIMNz; 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: 4FA583899E X-Spam-Score: -3.49 X-Migadu-Scanner: scn1.migadu.com X-TUID: i1UTjRQHCkvh Juan Manuel Mac=C3=ADas writes: >> Can you elaborate about "paragraph is exported as verbatim"? > > Sorry for the conciseness in my previous explanation. I meant something > like this: > > : foo > > is exported to LaTeX as > > \begin{verbatim} > foo > \end{verbatim} > > (and what i want is for it to be exported as 'normal text'). You can just #+name: foo foo that will be exported with all the markup. > By the way, thinking about it, I don't know if a hypothetical header arg > called :docstring would be ok, something like: > > #+NAME: foo > #+begin_ > blah > #+end_ > > #+begin_src emacs-lisp :docstring foo > (defun foo () > (message "hello world")) > #+end_src > > And the docstring would be formatted and placed depending on the > language and the code (https://en.wikipedia.org/wiki/Docstring). That's asking for too much. Supporting :docstring header argument in such form will require babel backends to parse the code, which may not be trivial. Or consider odd cases with polymorphic functions with the same name. However, note one past feature request about escaping text in noweb references: https://orgmode.org/list/82897e7d-f987-11f4-f7f5-fa1b8e462c0c@posteo.eu S=C3=A9bastien Miquel (2021-05-03) (2021 emacs= -orgmode.gnu.org maillist nolist) Subject: [Feature request] String escaped noweb expansion --=20 Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at