From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Sebastien Vauban Newsgroups: gmane.emacs.devel Subject: Re: Conventions for writing comments Date: Mon, 06 Oct 2014 17:06:18 +0200 Organization: Sebastien Vauban Message-ID: <86zjd9ck5x.fsf@example.com> References: <86h9zhh7w4.fsf@example.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1412608126 16177 80.91.229.3 (6 Oct 2014 15:08:46 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 6 Oct 2014 15:08:46 +0000 (UTC) To: emacs-devel-mXXj517/zsQ@public.gmane.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org-mXXj517/zsQ@public.gmane.org Mon Oct 06 17:08:40 2014 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Xb9tv-0004DA-Bl for ged-emacs-devel@m.gmane.org; Mon, 06 Oct 2014 17:08:39 +0200 Original-Received: from localhost ([::1]:52398 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xb9tu-0007L9-Sh for ged-emacs-devel@m.gmane.org; Mon, 06 Oct 2014 11:08:38 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58689) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xb9tb-0007Kx-7P for emacs-devel-mXXj517/zsQ@public.gmane.org; Mon, 06 Oct 2014 11:08:25 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Xb9tV-0006xZ-6H for emacs-devel-mXXj517/zsQ@public.gmane.org; Mon, 06 Oct 2014 11:08:19 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:46253) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xb9tV-0006vx-0E for emacs-devel-mXXj517/zsQ@public.gmane.org; Mon, 06 Oct 2014 11:08:13 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1Xb9tU-0003xm-28 for emacs-devel-mXXj517/zsQ@public.gmane.org; Mon, 06 Oct 2014 17:08:12 +0200 Original-Received: from dd5e0353a.access.telenet.be ([213.224.53.58]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 06 Oct 2014 17:08:12 +0200 Original-Received: from sva-news by dd5e0353a.access.telenet.be with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 06 Oct 2014 17:08:12 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 27 Original-X-Complaints-To: usenet-dbVV3NMTNubNLxjTenLetw@public.gmane.org X-Gmane-NNTP-Posting-Host: dd5e0353a.access.telenet.be X-Url: Under construction... X-Archive: encrypt User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.93 (windows-nt) Cancel-Lock: sha1:AKxyQY73j/gp6Kz3aQh2B0aQ87s= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: emacs-devel-mXXj517/zsQ@public.gmane.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org-mXXj517/zsQ@public.gmane.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org-mXXj517/zsQ@public.gmane.org Xref: news.gmane.org gmane.emacs.devel:175015 Archived-At: Stefan Monnier wrote: >> I have a small question about conventions for writing comments... Can >> I consider the following to be the rule? > > The main documentation we follow for coding style is the GNU Coding > Standard (https://www.gnu.org/prep/standards/html_node/Comments.html) > which says, among other things: > > Also, please write complete sentences and capitalize the first word. > >> - Otherwise (like ";; pattern found"), comments must begin with a small >> letter and don't end with a dot. > > I prefer to capitalize and punctuate this as well (BTW: this is also > a sentence). Interesting. I wouldn't have called that a sentence. For me, it should be "pattern is found" or "pattern has been found" or such to become a sentence. But that's out of the story, and the information is that, for you, the conventions are that *all* comments must be treated the same way. Thanks for the information. Best regards, Seb -- Sebastien Vauban