unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Andreas Schwab'" <schwab@linux-m68k.org>
Cc: 9274@debbugs.gnu.org
Subject: bug#9274: 24.0.50; doc string of `normal-top-level-add-subdirs-to-load-path'
Date: Wed, 10 Aug 2011 09:34:46 -0700	[thread overview]
Message-ID: <8491EA0175394F3E9696DB721F377469@us.oracle.com> (raw)
In-Reply-To: <m239h9cl0q.fsf@igel.home>

> > FWIW - Sheesh, what a horrible function name!  Should have 
> > been called something like `add-subdirs-to-load-path'.
> 
> It's a part of normal-top-level, so it's the perfect name.

Whatever.  It's part of GNU Emacs Lisp too, so maybe an even more perfect name
would be `gnu-emacs-lisp-normal-top-level-add-subdirs-to-load-path'?

I'm no expert on this, but "normal-top-level" itself seems like a lousy name
(what's normal about it? what are the non-normal top levels?)

BTW, `normal-top-level' rambles on for 5788 chars, including long, expository
comments trying to help make some sense of what's going on - a nearly sure sign
that things could be better organized.  And it is invoked from Lisp in only this
one sexp: (setq top-level (normal-top-level)) - nowhere else.

And I do not see `normal-top-level-add-subdirs-to-load-path' (or
`normal-top-level-add-to-load-path', for that matter) used anywhere in the body
of `normal-top-level'.  In fact, it is called from _no_ Lisp code whatsoever.

In what sense then is `n-t-l-a-s-t-l-p' (whew!) "part of normal-top-level" (an
internal function that doesn't even have a doc string, BTW)?

You will notice that the description (doc string) of `n-t-l-a-s-t-l-p' says
nothing about normal-top-level or even top-level.  If its description is
accurate, then the function name should reflect it, saying what the function
does.

If `normal-top-level' is so important to this function, then surely it should be
mentioned in its description.  Surely that would be more important than adding
this unexplained term to the name.

Anyway, this discussion is peripheral to this bug.  The name is monstrous, but
it is unlikely that it will ever be changed...






  reply	other threads:[~2011-08-10 16:34 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-08-09 22:25 bug#9274: 24.0.50; doc string of `normal-top-level-add-subdirs-to-load-path' Drew Adams
2011-08-09 23:11 ` Štěpán Němec
2011-08-10 16:02 ` Andreas Schwab
2011-08-10 16:34   ` Drew Adams [this message]
2011-08-10 18:57     ` Štěpán Němec
2011-08-10 21:37       ` Drew Adams
2011-08-20 19:30 ` 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

  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=8491EA0175394F3E9696DB721F377469@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=9274@debbugs.gnu.org \
    --cc=schwab@linux-m68k.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 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).