all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: 11328@debbugs.gnu.org
Subject: bug#11328: 24.1.50; Comment in `dired-copy-file-recursive' code
Date: Tue, 24 Apr 2012 10:37:09 -0700	[thread overview]
Message-ID: <0CC212AF2EA740A0B8FE5EEF91077A2D@us.oracle.com> (raw)

Just a nit.  But if you are going to add unnecessary comments to the
code that describe only what everyone can see the code does, then at
least get them right.  Otherwise you mislead readers.
 
This comment is incorrect: "Not a directory".  What is actually true at
that point is the following;
 
a. RECURSIVE is nil
b. RECURSIVE is non-nil and this is not a directory
c. this is a directory, RECURSIVE is non-nil and not `always',
   and the user replied `n'
 
(Similarly, the comment "This is a directory", though true, does not
convey the real meaning.  It is a directory AND it should be copied
recursively.)
 
It is a bad habit to add such comments to the code.  Comments should
generally be used when it is not obvious what the code does or why.
 
In GNU Emacs 24.1.50.1 (i386-mingw-nt5.1.2600)
 of 2012-04-23 on MARVIN
Bzr revision: 108006
agustin.martin@hispalinux.es-20120423103325-xmra3329elgzhmpc
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --no-opt --enable-checking --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include
 -ID:/devel/emacs/libs/libiconv-1.13.1-1-dev/include
 -ID:/devel/emacs/libs/libxml2-2.7.8/include/libxml2'
 






             reply	other threads:[~2012-04-24 17:37 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-04-24 17:37 Drew Adams [this message]
2012-04-24 17:49 ` bug#11328: 24.1.50; Comment in `dired-copy-file-recursive' code Drew Adams
2012-04-24 18:22   ` Drew Adams
2012-04-25 13:40     ` Nix
2012-04-25 16:26       ` Drew Adams
2012-04-25 18:42         ` Thierry Volpiatto
2012-04-25 21:51           ` Drew Adams
2012-04-26  5:48             ` Thierry Volpiatto
2012-04-26 14:09               ` Drew Adams
2012-04-26 15:35               ` Drew Adams
2012-04-26 18:38                 ` Thierry Volpiatto
2012-04-24 18:54 ` Stefan Monnier
2014-02-09  4:32 ` 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=0CC212AF2EA740A0B8FE5EEF91077A2D@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=11328@debbugs.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.