From: Marcin Borkowski <mbork@mbork.pl>
To: tomas@tuxteam.de
Cc: emacs-orgmode@gnu.org
Subject: Re: Docstrings and literate programming (good practices?)
Date: Fri, 04 Nov 2022 07:39:04 +0100 [thread overview]
Message-ID: <87mt976x6f.fsf@mbork.pl> (raw)
In-Reply-To: <Y2SnDd7zpKEKGbQV@tuxteam.de>
On 2022-11-04, at 06:45, tomas@tuxteam.de wrote:
> 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?
>>
>> 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.
>>
>> 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"...
I spat my tea. :-) Thanks, that's a nice one!
Though this _may_ work in some cases. For example, imagine you divide
your package into two files – one with user-facing commands and another
one with internal functions. If you order the former one carefully, the
"extract docstrings" might actually work as a documentation.
Still, a "normal" documentation seems a better (even if more
time-consuming) options.
Also, such docstring-based documentation is still better than none.
Best,
--
Marcin Borkowski
http://mbork.pl
next prev parent reply other threads:[~2022-11-04 6:40 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 [this message]
2022-11-04 7:13 ` Samuel Wales
2022-11-04 8:08 ` tomas
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=87mt976x6f.fsf@mbork.pl \
--to=mbork@mbork.pl \
--cc=emacs-orgmode@gnu.org \
--cc=tomas@tuxteam.de \
/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).