From: Yuval Langer <yuval.langer@gmail.com>
To: guile-devel@gnu.org
Subject: Texinfo in Guile Scheme docstrings?
Date: Fri, 26 Apr 2024 01:21:31 +0300 [thread overview]
Message-ID: <CAK0OjG2n5_R21rZOBggx0-4_KrMX+Qp84XKtUp2u-RNkkfsPgg@mail.gmail.com> (raw)
Hi,
I am writing docstrings to guile-srfi-189 currently[1] and looking for
good docstring style practices (that's another topic for another
thread).
I have noticed that there are some modules with Texinfo markup in
their docstrings, but I haven't found these markups being used in any
meaningful way. I looked up two docstrings inside the Guile manual,
but couldn't find it there, so these docstrings are not used to
de-duplicate documentation. The two I've searched are (srfi srfi-1)'s
assoc and (ice-9 popen)'s open-pipe*.
Someone had suggested the `guild doc-snarf` command, but it doesn't
output any of the docstrings. What I did notice is that the text in
the docstrings defined in the /libguile/ C files can be found in the
Guile manual. There is a tool called `guile-snarf` for the C code
docstrings, but that doesn't explain the Guile Scheme docstrings.
I am extremely confused. Why have Texinfo in the docstrings of the
Scheme source when the docstrings defined in the C files are used?
Are there plans for developing tools that will display docstring in a
more intelligent way using those markups, like in the interactive
environment, or maybe assist in navigating the documentation?
Thank you,
Yuval Langer.
[1]: <https://codeberg.org/kakafarm/guile-srfi-189/>
reply other threads:[~2024-04-25 22:21 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAK0OjG2n5_R21rZOBggx0-4_KrMX+Qp84XKtUp2u-RNkkfsPgg@mail.gmail.com \
--to=yuval.langer@gmail.com \
--cc=guile-devel@gnu.org \
/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.
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).