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:49:50 -0700	[thread overview]
Message-ID: <9DC04CC6E710430F90675022247AF8C1@us.oracle.com> (raw)
In-Reply-To: <0CC212AF2EA740A0B8FE5EEF91077A2D@us.oracle.com>

Oh, and since there is no doc string it might be a good idea to use better
parameter names.  There is a reason that for `copy-file' and
`make-symbolic-link' the parameter is called OK-IF-ALREADY-EXISTS and not simply
OK-FLAG.  (Same problem for `dired-copy-file'.)  You can guess the meaning from
OK-IF-ALREADY-EXISTS.

You are not helping readers of the code if they need to examine it all closely
to determine what a given parameter does.  In that case, you might as well name
the parameters X1, X2, X3, X4, X5, and X6.

And it's generally a good idea to use the same parameter names when you just
pass the arguments to another function and they have the same meaning.  If you
just pass PRESERVE-TIME to `copy-directory' and `copy-file', then use the same
name they use: KEEP-TIME.  (Or change all three and any other functions related
so they use the same names.)






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

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 [this message]
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=9DC04CC6E710430F90675022247AF8C1@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.