emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: On being web-friendly and why info must die


From: Eli Zaretskii
Subject: Re: On being web-friendly and why info must die
Date: Fri, 12 Dec 2014 17:04:03 +0200

> From: address@hidden (Phillip Lord)
> Date: Fri, 12 Dec 2014 14:50:00 +0000
> Cc: address@hidden, Ludovic Courtès <address@hidden>,
>       address@hidden
> 
> I don't want to put the docstring in. I want to put a reference to the
> docstring.

What for?  What problem would that solve?

> I want to write "(current-buffer)" and have it evaled when the doc is
> produced. This is the sort of thing that I expect when writing notes to
> teach programming. Why would I not want it in Emacs?

First, you _can_ do that in Emacs.  We have infrastructure and
functions that return the doc strings.

But for writing a manual, this is usually not the right thing to do.
When you write a manual, you need to think differently than when you
write a doc string, otherwise there will be little added value in the
manual.

Yes, I know about projects that generate Texinfo sources of their
manuals from the doc strings.  But I consider those manuals of a lower
quality than what we have in Emacs.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]