From: "João Távora" <joaotavora@gmail.com>
To: "Clément Pit-Claudel" <cpitclaudel@gmail.com>
Cc: Stefan Kangas <stefan@marxist.se>,
Emacs developers <emacs-devel@gnu.org>,
Michael Albinus <michael.albinus@gmx.de>,
Stefan Monnier <monnier@iro.umontreal.ca>,
Eli Zaretskii <eliz@gnu.org>, Anonymous <c4droid@foxmail.com>
Subject: Re: Some ideas with Emacs
Date: Sat, 30 Nov 2019 00:12:35 +0000 [thread overview]
Message-ID: <87o8wuusr0.fsf@gmail.com> (raw)
In-Reply-To: <4f3fe5b0-3a63-346e-5cea-bb5ed057e028@gmail.com> ("Clément Pit-Claudel"'s message of "Fri, 29 Nov 2019 16:42:28 -0500")
Clément Pit-Claudel <cpitclaudel@gmail.com> writes:
> On 2019-11-29 13:58, Michael Albinus wrote:
>> Personally, I don't like docstring to be too verbose. Usually, when a
>> function is documented with both docstrings and a manual, I prefer to
>> put the examples in the manual.
>
> I very seldom look at the ELisp manual, mostly because I don't think
> of it; one thing that would be great would be if there were links to
> the manual from the docstrings for functions that are covered in both.
Agree. There are some already. But many many more would be needed
Though wouldn't that unnecessarily spam the docstrings? Perhaps we
could automatically mark a .el file as documented in a specific node of
the manual and make that node automatically be referenced as "read
more about this in node..." in the docstring.
João
next prev parent reply other threads:[~2019-11-30 0:12 UTC|newest]
Thread overview: 120+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-29 9:05 Some ideas with Emacs Anonymous
2019-11-29 11:16 ` Marcin Borkowski
2019-11-29 11:44 ` =?gb18030?B?QW5vbnltb3Vz?=
2019-11-30 5:54 ` Emanuel Berg via Emacs development discussions.
2019-11-30 5:51 ` Emanuel Berg via Emacs development discussions.
2019-12-01 5:57 ` Richard Stallman
2019-12-01 10:56 ` Marcin Borkowski
2019-12-01 11:08 ` Marcin Borkowski
2019-12-01 13:40 ` VanL
2019-12-01 14:07 ` Marcin Borkowski
2019-12-02 4:52 ` VanL
2019-12-02 6:12 ` Marcin Borkowski
2019-12-03 5:01 ` Richard Stallman
2019-12-03 15:45 ` Eli Zaretskii
2019-12-03 16:21 ` Emanuel Berg via Emacs development discussions.
2019-12-03 17:35 ` Eli Zaretskii
2019-12-03 17:59 ` Stefan Monnier
2019-12-03 19:51 ` Emanuel Berg via Emacs development discussions.
2019-12-03 19:32 ` Marcin Borkowski
2019-12-03 19:37 ` Eli Zaretskii
2019-12-03 23:08 ` Marcin Borkowski
2019-12-04 3:42 ` Eli Zaretskii
2019-12-06 18:29 ` Marcin Borkowski
2019-12-04 8:39 ` VanL
2019-12-03 23:12 ` Marcin Borkowski
2019-12-05 4:41 ` Richard Stallman
2019-12-06 6:51 ` VanL
2019-12-06 20:13 ` Marcin Borkowski
2019-12-06 23:58 ` VanL
2019-12-02 5:41 ` Richard Stallman
2019-12-02 12:53 ` Marcin Borkowski
2019-12-02 18:07 ` Stefan Monnier
2019-12-02 20:57 ` Marcin Borkowski
2019-12-02 21:19 ` Stefan Monnier
2019-12-02 22:13 ` Marcin Borkowski
2019-12-02 22:41 ` Stefan Monnier
2019-12-02 23:04 ` Marcin Borkowski
2019-12-03 0:20 ` Stefan Monnier
2019-12-03 23:26 ` Marcin Borkowski
2019-12-03 8:37 ` VanL
2019-12-03 10:14 ` Marcin Borkowski
2019-12-03 11:14 ` VanL
2019-12-05 4:44 ` Richard Stallman
2019-12-05 7:30 ` Elias Mårtenson
2019-12-06 4:11 ` Richard Stallman
2019-12-07 2:21 ` Elias Mårtenson
2019-12-08 5:06 ` Librepay Richard Stallman
2019-12-08 12:10 ` Librepay VanL
2019-12-03 5:03 ` Some ideas with Emacs Richard Stallman
2019-12-03 4:58 ` Richard Stallman
2019-12-04 0:37 ` Marcin Borkowski
2019-12-05 4:41 ` Richard Stallman
2020-05-11 19:37 ` Marcin Borkowski
2020-06-03 4:25 ` Richard Stallman
2019-11-29 11:37 ` Stefan Kangas
2019-11-29 11:59 ` Anonymous
2019-11-29 12:31 ` Emacs: the Editor for the Next Forty Years (was Re: Some ideas with Emacs) Juanma Barranquero
2019-11-29 13:22 ` Some ideas with Emacs Eli Zaretskii
2019-11-29 13:34 ` Stefan Kangas
2019-11-29 13:56 ` Eduardo Ochs
2019-11-29 14:13 ` Eli Zaretskii
2019-11-29 14:26 ` Anonymous
2019-11-30 3:51 ` Stefan Kangas
2019-12-01 3:14 ` Emanuel Berg via Emacs development discussions.
2019-11-29 15:36 ` Stefan Monnier
2019-11-29 18:58 ` Michael Albinus
2019-11-29 19:13 ` Adding examples in the doc (was: Some ideas with Emacs) Stefan Monnier
2019-11-29 19:30 ` Yuan Fu
2019-11-29 20:03 ` Adding examples in the doc Michael Albinus
2019-11-29 19:32 ` Some ideas with Emacs Eli Zaretskii
2019-11-29 20:09 ` Michael Albinus
2019-11-29 20:14 ` Eli Zaretskii
2019-11-29 20:25 ` Michael Albinus
2019-11-29 20:30 ` Eli Zaretskii
2019-12-01 6:25 ` Emanuel Berg via Emacs development discussions.
2019-12-01 7:35 ` Eduardo Ochs
2019-12-01 10:21 ` Michael Albinus
2019-12-01 6:19 ` Emanuel Berg via Emacs development discussions.
2019-11-29 21:42 ` Clément Pit-Claudel
2019-11-30 0:12 ` João Távora [this message]
2019-12-01 6:48 ` Emanuel Berg via Emacs development discussions.
2019-12-01 17:30 ` Eli Zaretskii
2019-11-30 0:44 ` Yuan Fu
2019-11-30 4:00 ` Stefan Kangas
2019-11-30 7:19 ` Eli Zaretskii
2019-11-30 7:05 ` Eli Zaretskii
2019-12-01 6:51 ` Emanuel Berg via Emacs development discussions.
2019-12-01 17:32 ` Eli Zaretskii
2019-12-01 18:25 ` Emanuel Berg via Emacs development discussions.
2019-12-01 19:44 ` Michael Welsh Duggan
2019-12-01 20:48 ` Eli Zaretskii
2019-12-01 21:35 ` Emanuel Berg via Emacs development discussions.
2019-12-02 3:32 ` Eli Zaretskii
2019-12-02 4:17 ` Emanuel Berg via Emacs development discussions.
2019-12-02 4:48 ` Yuan Fu
2019-12-02 4:53 ` Emanuel Berg via Emacs development discussions.
2019-12-02 15:57 ` Michael Albinus
2019-12-01 22:20 ` Michael Welsh Duggan
2019-12-01 22:46 ` Emanuel Berg via Emacs development discussions.
2019-12-01 6:46 ` Emanuel Berg via Emacs development discussions.
2019-12-01 3:21 ` Emanuel Berg via Emacs development discussions.
2019-12-01 6:04 ` Richard Stallman
2019-12-01 6:15 ` Emanuel Berg via Emacs development discussions.
2019-12-01 6:05 ` Richard Stallman
2019-11-29 15:43 ` Stefan Monnier
2019-11-29 16:04 ` Robert Pluim
2019-11-30 11:21 ` Emanuel Berg via Emacs development discussions.
2019-12-01 2:41 ` VanL
2019-12-01 18:05 ` Stefan Monnier
2019-12-01 18:36 ` Emanuel Berg via Emacs development discussions.
2019-12-03 6:07 ` Ag Ibragimov
2019-12-06 18:30 ` Marcin Borkowski
2019-12-06 19:18 ` Juanma Barranquero
2019-12-06 20:14 ` Marcin Borkowski
2019-12-06 21:22 ` Stefan Monnier
2019-12-06 21:26 ` Juanma Barranquero
2019-12-07 2:13 ` Ag Ibragimov
2019-12-07 3:14 ` Drew Adams
2019-12-10 20:55 ` Marcin Borkowski
2019-12-11 4:21 ` VanL
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=87o8wuusr0.fsf@gmail.com \
--to=joaotavora@gmail.com \
--cc=c4droid@foxmail.com \
--cc=cpitclaudel@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=michael.albinus@gmx.de \
--cc=monnier@iro.umontreal.ca \
--cc=stefan@marxist.se \
/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.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.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).