unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#11328: 24.1.50; Comment in `dired-copy-file-recursive' code
@ 2012-04-24 17:37 Drew Adams
  2012-04-24 17:49 ` Drew Adams
                   ` (2 more replies)
  0 siblings, 3 replies; 13+ messages in thread
From: Drew Adams @ 2012-04-24 17:37 UTC (permalink / raw)
  To: 11328

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'
 






^ permalink raw reply	[flat|nested] 13+ messages in thread

end of thread, other threads:[~2014-02-09  4:32 UTC | newest]

Thread overview: 13+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-04-24 17:37 bug#11328: 24.1.50; Comment in `dired-copy-file-recursive' code Drew Adams
2012-04-24 17:49 ` 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

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).