From: Eli Zaretskii <eliz@gnu.org>
To: "Vincent Belaïche" <vincent.b.1@hotmail.fr>
Cc: vincent.b.1@hotmail.fr, monnier@iro.umontreal.ca, emacs-devel@gnu.org
Subject: Re: 5x5 Arithmetic solver
Date: Sat, 21 May 2011 10:49:27 +0300 [thread overview]
Message-ID: <83hb8ofq7s.fsf@gnu.org> (raw)
In-Reply-To: <80r57s4j82.fsf@gmail.com>
> From: Vincent Belaïche <vincent.b.1@hotmail.fr>
> Date: Sat, 21 May 2011 09:15:57 +0200
> Cc: Vincent Belaïche <vincent.b.1@hotmail.fr>
>
> >- Please capitalize your comments and terminate them with a "." or some
> > other appropriate punctuation.
> [...]
> For all the remaining comments I have done it
Did you send the corrected version? Because I still see
non-capitalized comments that don't fall under any of your exceptions:
> + ;; transfer matrix is the 25x25 matrix applied everytime a flip is
> + ;; carried out where a flip is defined by a 25x1 Dirac vector --- ie
> + ;; all zeros but 1 in the position that is flipped.
> [...]
> + ;; by construction ctransferm-:-2 = 0, so ctransferm-1-2 = 0
> + ;; and ctransferm-2-2 = 0
> [...]
> + ;; any cx-2 can do, so there are 2^transferm-kernel-size solutions
> + (solution-list
> + ;; within solution-list each element is a cons cell (HW . SOL) where
> + ;; HW is the Hamming weight of solution, and SOL is the solution in
> + ;; the form of a grid.
> [...]
> + ;; sort solutions according to respective Hamming weight
By the way, please leave two spaces after the period that ends a
sentence. This is our convention in any text we write in Emacs,
including comments, doc strings, and manuals.
> >- we need a ChangeLog entry.
>
> Here it is:
>
> -----------------------------------------------------------------------
> 2011-05-21 Vincent Belaïche <vincentb1@users.sourceforge.net>
>
> * play/5x5.el: Add an arithmetic solver to suggest positions to
> click on.
> -----------------------------------------------------------------------
No, that's not enough. What you've written is the summary line, but
the ChangeLog also needs the details: which functions and variables
were added or deleted, which were modified and how, etc. Like this:
(5x5-solver-output): New defvar.
(5x5-local-variables): New defconst.
(5x5-mode): Make all variables in 5x5-local-variables local.
(5x5): Set 5x5-grid-size only if SIZE is non-negative.
etc. You can see plenty of examples of the exact style in the
ChangeLog files.
Please also spell-check your comments and doc strings, there are a few
non-English words I spotted here and there.
Thanks.
next prev parent reply other threads:[~2011-05-21 7:49 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-05-21 7:15 5x5 Arithmetic solver Vincent Belaïche
2011-05-21 7:49 ` Eli Zaretskii [this message]
2011-05-21 14:36 ` Vinicius Jose Latorre
2011-05-21 16:12 ` Vincent Belaïche
2011-05-21 23:29 ` Stefan Monnier
-- strict thread matches above, loose matches on Subject: below --
2011-05-22 20:35 Vincent Belaïche
2011-05-23 14:47 ` Stefan Monnier
2011-05-21 18:15 Vincent Belaïche
2011-05-21 19:03 ` Eli Zaretskii
2011-05-21 23:31 ` Stefan Monnier
2011-05-22 7:32 ` Vincent Belaïche
2011-05-22 19:09 ` Stefan Monnier
2011-05-19 20:21 Vincent Belaïche
2011-05-20 13:45 ` Stefan Monnier
2011-05-20 14:03 ` Antoine Levitt
2011-05-21 6:38 ` Vincent Belaïche
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=83hb8ofq7s.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
--cc=vincent.b.1@hotmail.fr \
/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).