all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Glenn Morris'" <rgm@gnu.org>, <1351@emacsbugs.donarmstrong.com>
Subject: bug#1351: 23.0.60; Provide doc strings for functions in replace.el
Date: Sat, 15 Nov 2008 16:06:21 -0800	[thread overview]
Message-ID: <005d01c9477f$28716ab0$0200a8c0@us.oracle.com> (raw)
In-Reply-To: <18719.21523.444893.763878@fencepost.gnu.org>

> From: Glenn Morris Sent: Saturday, November 15, 2008 2:58 PM
> Yes, many functions in Emacs unfortunately lack doc strings. It is not
> very difficult to find them. Let me save you the trouble of opening
> bugs for them all:
> (let (undocumented)
>   (mapatoms (lambda (s)
>               (and (fboundp s)
>                    (not (documentation s))
>                    (push s undocumented))))
>   undocumented))

Impertinent and not helpful. I'm not looking for them all. This is not a report
that all functions and variables need doc strings.

The functions and variables I reported, in particular, could use doc strings.
That would help at least one user, me, understand the code.

> Would you like to write some?

No.

When I understand code that lacks doc strings where doc strings would help, I
don't hesitate to send proposed doc along. Likewise, for doc-string corrections.
When I don't understand code that lacks doc strings, I report that they could
help understanding.

Would you like to write some? If not, pass. Let me save you the trouble of
responding uselessly to bug reports - feel free not to bother.









  parent reply	other threads:[~2008-11-16  0:06 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <18721.11954.779606.826706@fencepost.gnu.org>
2008-11-15 19:20 ` bug#1351: 23.0.60; Provide doc strings for functions in replace.el Drew Adams
2008-11-15 22:58   ` Glenn Morris
2008-11-15 23:27     ` Juanma Barranquero
2008-11-15 23:43       ` Glenn Morris
2008-11-15 23:50         ` Processed: " Emacs bug Tracking System
2008-11-16  0:06     ` Drew Adams [this message]
2008-11-16  4:19       ` Eli Zaretskii
2008-11-16  8:05         ` Drew Adams
2008-11-16 21:58           ` Eli Zaretskii
2008-11-16 23:13             ` Stefan Monnier
2008-11-17  8:50   ` bug#1353: marked as done (c-put-char-property-fun alias problem) Emacs bug Tracking System
2014-02-10  3:38   ` bug#1351: 23.0.60; Provide doc strings for functions in replace.el Lars Ingebrigtsen

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='005d01c9477f$28716ab0$0200a8c0@us.oracle.com' \
    --to=drew.adams@oracle.com \
    --cc=1351@emacsbugs.donarmstrong.com \
    --cc=rgm@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.
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.