emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Thoughts on weaving variable documentation
@ 2014-06-20 16:10 Grant Rettke
  2014-06-20 16:11 ` Grant Rettke
                   ` (2 more replies)
  0 siblings, 3 replies; 6+ messages in thread
From: Grant Rettke @ 2014-06-20 16:10 UTC (permalink / raw)
  To: emacs-orgmode@gnu.org

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2014-06-24 14:01 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-06-20 16:10 Thoughts on weaving variable documentation Grant Rettke
2014-06-20 16:11 ` 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

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).