From: "Drew Adams" <drew.adams@oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi@gnus.org>
Cc: 1144@debbugs.gnu.org
Subject: bug#1144: closed by Chong Yidong <cyd@stupidchicken.com> (Re: 23.0.60; No doc string for `symbol-at-point' and other, similar functions)
Date: Thu, 7 Jul 2011 10:30:21 -0700 [thread overview]
Message-ID: <C4E7C37474584AD5B447E69A9AB16F40@us.oracle.com> (raw)
In-Reply-To: <m3hb6yt40i.fsf@quimbies.gnus.org>
> >> Must I send a separate bug for each such function? I thought
> >> when your complete response was "Done" that you had taken
> >> care of all such functions.
> >>
> >> The following functions are all in the same boat. They are
> >> all functions for which users will want to see the doc.
> >>
> >> beginning-of-thing
> >> end-of-thing
> >> in-string-p
> >> end-of-sexp
> >> beginning-of-sexp
> >> thing-at-point-bounds-of-url-at-point
> >> forward-whitespace
> >> forward-symbol
> >> forward-same-syntax
> >> word-at-point
> >> sentence-at-point
> >> form-at-point
>
> No, Chong added documentation to the autoloaded, "external" functions,
> but not the purely internal thingatpt functions. And I think
> that's the right decision.
No, it's not the right thing. Emacs users include Emacs-Lisp users. Users of
thingatpt.el, in particular, are mainly Emacs-Lisp users.
Whether to document something has nothing to do with whether it is a command or
is autoloaded. That is, those predicates do not at all suffice to determine
whether something should be documented.
And for Emacs there really is no such thing as an "internal" function. Yes, we
need not document every function or variable, and yes, some functions and
variables we generally do not expect users to fiddle with. But Emacs is 100%
open, and it should document itself, as originally intended.
next prev parent reply other threads:[~2011-07-07 17:30 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <87ljwgbbh8.fsf@cyd.mit.edu>
2008-10-11 21:56 ` bug#1144: 23.0.60; No doc string for `symbol-at-point' and other, similar functions Drew Adams
2008-10-22 21:00 ` bug#1144: marked as done (23.0.60; No doc string for `symbol-at-point' and other, similar functions) Emacs bug Tracking System
[not found] ` <handler.1144.D1144.12247086444763.notifdone@emacsbugs.donarmstrong.com>
2009-04-06 6:24 ` bug#1144: closed by Chong Yidong <cyd@stupidchicken.com> (Re: 23.0.60; " Drew Adams
2011-07-07 17:05 ` Lars Magne Ingebrigtsen
2011-07-07 17:30 ` Drew Adams [this message]
2011-07-07 18:32 ` Chong Yidong
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=C4E7C37474584AD5B447E69A9AB16F40@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=1144@debbugs.gnu.org \
--cc=larsi@gnus.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.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.