From mboxrd@z Thu Jan  1 00:00:00 1970
X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me
X-Spam-Level: 
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=ham
	autolearn_force=no version=3.4.4
X-Google-Thread: a07f3367d7,429176cb92b1b825
X-Google-Attributes: gida07f3367d7,public,usenet
X-Google-NewGroupId: yes
X-Google-Language: ENGLISH,UTF8
Path: 
 g2news2.google.com!news4.google.com!feeder3.cambriumusenet.nl!feed.tweaknews.nl!193.201.147.78.MISMATCH!feeder.news-service.com!news.netcologne.de!newsfeed-fusi2.netcologne.de!news.buerger.net!LF.net!news.enyo.de!not-for-mail
From: Florian Weimer <fw@deneb.enyo.de>
Newsgroups: comp.lang.ada
Subject: Re: AWS Coding Styles (and about boring plain-linear text files in
 the end)
Date: Tue, 18 Jan 2011 20:07:20 +0100
Message-ID: <87lj2ido9j.fsf@mid.deneb.enyo.de>
References: <op.vpfsjkfdule2fv@garhos>
	<24418fa4-8843-4fe6-8c2f-026ea6009b68@g26g2000vbz.googlegroups.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
X-Trace: ruchba.enyo.de 1295377641 3268 172.17.135.6 (18 Jan 2011 19:07:21
 GMT)
X-Complaints-To: news@enyo.de
Cancel-Lock: sha1:DEoW862NuJXsmuKEsEROvuROM6k=
Xref: g2news2.google.com comp.lang.ada:17494
Date: 2011-01-18T20:07:20+01:00
List-Id: <comp.lang.ada>

* pascal:

>>     > Comments describing a subprogram spec should specifically
>>     > mention the formal argument names. General rule: write a
>>     > comment that does not depend on the names of things.
>>
>>     Q: I am afraid I did not understood this one, as it seems
>>        ambiguous to me. How to refer to formal argument names
>>        without refering to the names of things ? Or else, are
>>        does “names of things” refer to in this context ?
>
> Instead of saying:
>
>    procedure Call (Filename : String);
>    --  The name of the file should be an absolute name
>
> Say:
>
>    procedure Call (Filename : String);
>    --  Filename must be an abosulute name

The problem is that the rule is self-contradictory.  I think it should
say, "should not specifically mention", i.e., the opposite of what you
suggested.

I will submit a patch to gcc/ada/gnat-style.texi to fix this.