|
From: | Joost Kremers |
Subject: | Re: docstrings and elisp reference |
Date: | Tue, 06 Jun 2017 22:45:25 +0200 |
User-agent: | mu4e 0.9.19; emacs 25.2.50.1 |
On Tue, Jun 06 2017, Stephen Leake wrote:
Doc strings are for short reference information for single functions/variables.texinfo docs are for more indepth explanations of several related functions/features.They are complementary; they should not duplicate each other.
And yet, the Elisp manual documents a large number of functions and variables / options in a format that is very reminiscent of doc strings and which provides basically the same information. I kinda see the point in making the doc string and that description identical. Obviously, the manual gives a lot more background info and groups the functions and variables together in a meaningful way, but wouldn't it make sense / be possible to extract the descriptions in the manual directly from the source?
-- Joost Kremers Life has its moments
[Prev in Thread] | Current Thread | [Next in Thread] |