From: tomas@tuxteam.de
To: Samuel Wales <samologist@gmail.com>
Cc: Marcin Borkowski <mbork@mbork.pl>, emacs-orgmode@gnu.org
Subject: Re: Docstrings and literate programming (good practices?)
Date: Fri, 4 Nov 2022 09:08:46 +0100 [thread overview]
Message-ID: <Y2TIjjMibT2rsQZ1@tuxteam.de> (raw)
In-Reply-To: <CAJcAo8tj0yan9PGwDVpN1t4mOSYykR-L1zaZ45wy0ebfQQ1=aw@mail.gmail.com>
[-- Attachment #1: Type: text/plain, Size: 631 bytes --]
On Fri, Nov 04, 2022 at 12:13:30AM -0700, Samuel Wales wrote:
> my dry sensibilities say don't write ht same thing in the manual that
> is well written in the docstring. idk the issues however, other than
> that once you do it in two places murphy's law says they will get out
> of sync.
Absolutely. I can well imagine docstrings going into a reference.
> but surely an extractor could look for an interactive spec and things
> like htat could subset the functions and text.
My complaints were not so much about the extractors themselves as
about the kind of docs that tend to be made with them.
Cheers
--
t
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]
next prev parent reply other threads:[~2022-11-04 8:10 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-01 14:07 Docstrings and literate programming (good practices?) Juan Manuel Macías
2022-11-02 7:13 ` Ihor Radchenko
2022-11-02 7:53 ` Dr. Arne Babenhauserheide
2022-11-02 10:43 ` Ihor Radchenko
2022-11-02 12:49 ` Juan Manuel Macías
2022-11-02 13:05 ` Ihor Radchenko
2022-11-02 15:20 ` Juan Manuel Macías
2022-11-03 7:38 ` Ihor Radchenko
2022-11-03 20:54 ` Rudolf Adamkovič
2022-11-04 3:03 ` Samuel Wales
2022-11-04 5:45 ` tomas
2022-11-04 6:39 ` Marcin Borkowski
2022-11-04 7:13 ` Samuel Wales
2022-11-04 8:08 ` tomas [this message]
2022-11-04 8:06 ` tomas
2022-11-04 8:49 ` Ihor Radchenko
2022-11-05 2:07 ` Samuel Wales
2022-11-08 4:10 ` Samuel Wales
2022-11-04 11:45 ` Max Nikulin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Y2TIjjMibT2rsQZ1@tuxteam.de \
--to=tomas@tuxteam.de \
--cc=emacs-orgmode@gnu.org \
--cc=mbork@mbork.pl \
--cc=samologist@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).