From: Javier <nospam@nospam.com>
To: help-gnu-emacs@gnu.org
Subject: Re: Emacs Mini Manual (PART 3) - CUSTOMIZING AND EXTENDING EMACS
Date: Sat, 12 Jul 2014 23:30:30 +0000 (UTC) [thread overview]
Message-ID: <lpsgem$lpp$1@speranza.aioe.org> (raw)
In-Reply-To: 87ha2mici8.fsf@debian.uxu
> Yeah? What documents?
>
> You can get the Emacs manual in texinfo here:
> http://www.gnu.org/software/emacs/manual/texi/emacs.texi.tar.gz
I mean having in info format documents like this
http://en.cppreference.com/w/Main_Page
It's just an example, I just mean that there isn't that much
documentation available in info format. Those documents could
be converted to info, but html->info conversion is too problematic.
Of course emacs/elisp are already documented in info format (as pretty
much everything that is done by the FSF: bash, gcc, coreutils...)
Emanuel Berg <embe8573@student.uu.se> wrote:
> Javier <nospam@nospam.com> writes:
>
>>> Yes, documentation on-screen is great in the man
>>> page sense, the online Emacs help sense, when you
>>> want to know some part of the interface. If you do
>>> Elisp for some time, and then switch to C, you feel
>>> like an idiot having to Google stuff because the
>>> interface isn't available (though some of the C is
>>> in the manpages). But there is actually nothing that
>>> stops anyone from writing C (interface)
>>> documentation that would work more or less like the
>>> Elisp one.
>>
>> It would be an interesting project to convert those
>> documents to texinfo format. With Python it is
>> possible to convert the documentation (sphinx doc
>> generator) of Python and its libraries to texinfo,
>> and documentation can be gerated automatically for
>> any python project to texinfo.
>
> Yeah? What documents?
>
> You can get the Emacs manual in texinfo here:
>
> http://www.gnu.org/software/emacs/manual/texi/emacs.texi.tar.gz
>
> I take it that's what you get with the info command,
> only not markuped, of course.
>
> In the the on-line help, the docstrings associated to
> defuns and variables, they aren't that advanced.
>
> The arguments should be mentioned, in caps - probably
> to make them visible - they get the
> `help-argument-name' face. In the source, it looks kind
> of strange with arguments not the same case in the
> docstring as everywhere else. But in help-mode the
> parameters in the definition gets uppercased, so there
> it's consistent.
>
> All parameters should be mentioned, in the docstring,
> and there should be two spaces after a full stop. This
> is something I learned from `checkdoc-current-buffer',
> check out this example - it should tell you arg2 isn't
> mentioned (apart from some other library related stuff
> that doesn't apply). But in reality far from everything
> is documented and sometimes it is, but not the
> parameters...
>
> (defun test-param-doc (arg1 arg2)
> "ARG1 does this. Also check out `find-file'."
> (interactive)
> nil) ; eval here
>
> (checkdoc-current-buffer t) ; and here
>
> Some hypertext is possible with `this' method - if
> there actually is such a function or whatever, that get
> hypertexted and the `button' face in help-mode.
>
next prev parent reply other threads:[~2014-07-12 23:30 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-07-01 4:41 Emacs Mini Manual (PART 3) - CUSTOMIZING AND EXTENDING EMACS solidius4747
2014-07-01 7:44 ` James Freer
[not found] ` <mailman.4638.1404200703.1147.help-gnu-emacs@gnu.org>
2014-07-01 14:16 ` Emanuel Berg
2014-07-01 14:38 ` James Freer
[not found] ` <mailman.4649.1404225527.1147.help-gnu-emacs@gnu.org>
2014-07-08 8:36 ` solidius4747
2014-07-08 15:09 ` Emanuel Berg
2014-07-08 16:18 ` Drew Adams
2014-07-08 16:45 ` solidius4747
2014-07-08 21:36 ` Emanuel Berg
2014-07-09 2:41 ` solidius4747
2014-07-09 8:52 ` Robert Thorpe
2014-07-09 17:11 ` Emanuel Berg
2014-08-25 14:05 ` Jude DaShiell
2014-07-08 18:56 ` Robert Thorpe
[not found] ` <mailman.5091.1404836351.1147.help-gnu-emacs@gnu.org>
2014-07-08 21:21 ` Emanuel Berg
2014-07-09 8:44 ` Robert Thorpe
2014-07-10 2:11 ` Bob Proulx
[not found] ` <mailman.5163.1404958319.1147.help-gnu-emacs@gnu.org>
2014-07-10 22:16 ` Emanuel Berg
2014-07-12 14:52 ` Javier
2014-07-12 19:49 ` Emanuel Berg
2014-07-12 23:30 ` Javier [this message]
2014-07-13 16:52 ` Emanuel Berg
2014-07-13 1:40 ` Robert Thorpe
2014-07-07 23:12 ` Emanuel Berg
2014-07-08 8:37 ` solidius4747
2014-07-08 15:15 ` Emanuel Berg
2014-07-08 16:48 ` solidius4747
2014-07-08 21:43 ` Emanuel Berg
[not found] <mailman.5117.1404898261.1147.help-gnu-emacs@gnu.org>
2014-07-09 16:55 ` Emanuel Berg
2014-07-11 11:51 ` Robert Thorpe
[not found] <mailman.5279.1405079523.1147.help-gnu-emacs@gnu.org>
2014-07-11 12:07 ` Emanuel Berg
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/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='lpsgem$lpp$1@speranza.aioe.org' \
--to=nospam@nospam.com \
--cc=help-gnu-emacs@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).