[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: docstrings and elisp reference
From: |
Stefan Monnier |
Subject: |
Re: docstrings and elisp reference |
Date: |
Wed, 07 Jun 2017 09:03:04 -0400 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/26.0.50 (gnu/linux) |
> 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.
Agreed. And I also think this is a problem.
>From where I stand, the way to fix it is:
- Better integration between the manual browser and the docstring
browser, so you can click on a function/variable name in the manual to
get to its docstring and you can easily jump from a docstring to the
relevant section of the manual.
- Remove the redundant var/fun documentation from the manual (this is
a tedious job: there is some redundance but it's not systematic, so
we can't just do this removal systematically).
- Come up with a way to re-add those var/fun documentation into the
printed manual (e.g. by adding to the Texinfo source external
references to docstrings, which are then processed by now ad-hoc
script).
Stefan
- Re: docstrings and elisp reference, (continued)
- Re: docstrings and elisp reference, Eli Zaretskii, 2017/06/10
- Re: docstrings and elisp reference, Richard Stallman, 2017/06/10
- Re: docstrings and elisp reference, Richard Stallman, 2017/06/10
- Re: docstrings and elisp reference, Stefan Monnier, 2017/06/11
- Re: docstrings and elisp reference, Richard Stallman, 2017/06/11
- Re: docstrings and elisp reference, Stefan Monnier, 2017/06/11
- Re: docstrings and elisp reference, Richard Stallman, 2017/06/12
- Re: docstrings and elisp reference, Yuri Khan, 2017/06/10
- Re: docstrings and elisp reference, Richard Stallman, 2017/06/09
- Re: docstrings and elisp reference, Joost Kremers, 2017/06/06
- Re: docstrings and elisp reference,
Stefan Monnier <=
- Re: docstrings and elisp reference, Yuri Khan, 2017/06/07
- Re: docstrings and elisp reference, Stefan Monnier, 2017/06/07
- RE: docstrings and elisp reference, Drew Adams, 2017/06/07
- Re: docstrings and elisp reference, Eli Zaretskii, 2017/06/07
- Re: docstrings and elisp reference, Dmitry Gutov, 2017/06/06
- RE: docstrings and elisp reference, Drew Adams, 2017/06/06
- Re: docstrings and elisp reference, Dmitry Gutov, 2017/06/06
- Re: docstrings and elisp reference, Eli Zaretskii, 2017/06/07
- Re: docstrings and elisp reference, Dmitry Gutov, 2017/06/17
- Re: docstrings and elisp reference, Alan Mackenzie, 2017/06/17