From: Grant Rettke <gcr@wisdomandwonder.com>
To: "emacs-orgmode@gnu.org" <emacs-orgmode@gnu.org>
Subject: Thoughts on weaving variable documentation
Date: Fri, 20 Jun 2014 11:10:39 -0500 [thread overview]
Message-ID: <CAAjq1mcOv-o48DT3pShkySpSDaL_6NgLFeTGwJyi81Ag0QaYSw@mail.gmail.com> (raw)
Good morning,
A lot of people are weaving their Emacs init files for the obvious
reason: it is difficult to remember why
we configured stuff and other people definitely won't know why we did
it. There is a common operation
that occurs though when other people read our Emacs init:
1. They open it up in Emacs
2. Find what looks interesting
3. Do a C-h f or C-h v on it and learn about it
Makes total sense.
What I got curious about is for this specific use case, people
scanning other people's configs, how I
could make it easier. A thought is to weave the docstrings for
variables right into the weaved file any
time a variable is set. I am thinking something like this:
1. When the weave occurs
2. Look at each line of code that starts with a setq
3. Look up the docstring for the variable
4. TBD: Weave that documentation into the output.
That is the idea, at least.
My question is:
1. What are the standard mechanisms to do something like this within
the ob lifecycle?
2. What do you think in general?
Kind regards,
Grant Rettke | ACM, ASA, FSF, IEEE, SIAM
gcr@wisdomandwonder.com | http://www.wisdomandwonder.com/
“Wisdom begins in wonder.” --Socrates
((λ (x) (x x)) (λ (x) (x x)))
“Life has become immeasurably better since I have been forced to stop
taking it seriously.” --Thompson
next reply other threads:[~2014-06-20 16:10 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-06-20 16:10 Grant Rettke [this message]
2014-06-20 16:11 ` Thoughts on weaving variable documentation Grant Rettke
2014-06-21 5:58 ` Aaron Ecay
2014-06-21 23:20 ` Grant Rettke
2014-06-24 12:17 ` Fabrice Niessen
2014-06-24 14:00 ` Grant Rettke
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=CAAjq1mcOv-o48DT3pShkySpSDaL_6NgLFeTGwJyi81Ag0QaYSw@mail.gmail.com \
--to=gcr@wisdomandwonder.com \
--cc=emacs-orgmode@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.
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).