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,FREEMAIL_FROM autolearn=unavailable autolearn_force=no version=3.4.4 X-Received: by 2002:a24:7996:: with SMTP id z144-v6mr13029165itc.10.1539597951821; Mon, 15 Oct 2018 03:05:51 -0700 (PDT) X-Received: by 2002:aca:37c1:: with SMTP id e184-v6mr277040oia.5.1539597951693; Mon, 15 Oct 2018 03:05:51 -0700 (PDT) Path: eternal-september.org!reader01.eternal-september.org!reader02.eternal-september.org!feeder.eternal-september.org!2.eu.feeder.erje.net!4.us.feeder.erje.net!feeder.erje.net!feeder.usenetexpress.com!feeder-in1.iad1.usenetexpress.com!border1.nntp.dca1.giganews.com!nntp.giganews.com!x98-v6no15810ita.0!news-out.google.com!n199-v6ni31itn.0!nntp.google.com!x98-v6no15809ita.0!postnews.google.com!glegroupsg2000goo.googlegroups.com!not-for-mail Newsgroups: comp.lang.ada Date: Mon, 15 Oct 2018 03:05:51 -0700 (PDT) In-Reply-To: <7fcdcc97-67e4-473b-abc4-cd0ecd4501ad@googlegroups.com> Complaints-To: groups-abuse@google.com Injection-Info: glegroupsg2000goo.googlegroups.com; posting-host=2003:c7:83d2:5618:c10f:2fea:a77d:c475; posting-account=rmHyLAoAAADSQmMWJF0a_815Fdd96RDf NNTP-Posting-Host: 2003:c7:83d2:5618:c10f:2fea:a77d:c475 References: <7fcdcc97-67e4-473b-abc4-cd0ecd4501ad@googlegroups.com> User-Agent: G2/1.0 MIME-Version: 1.0 Message-ID: <45ed49eb-1849-40b3-bfae-5423fae9b164@googlegroups.com> Subject: Re: Is the Documentation In a spec File Usually Enough For You ? From: AdaMagica Injection-Date: Mon, 15 Oct 2018 10:05:51 +0000 Content-Type: text/plain; charset="UTF-8" Xref: reader02.eternal-september.org comp.lang.ada:54583 Date: 2018-10-15T03:05:51-07:00 List-Id: If you think of nonlanguage defined libraries, I must say that what I've seen so far is mostly very poorly documented. It's rarely the case that the pure Ada text in the package specs is enough to understand how a library works and how it is supposed to be used. At least a lot of comments should be included. In an ideal world, any libraries should be documented in the same detail as all language supplied ones in the RM. This is almost never the case. The biggest sin: If you want to use some library and have to look into the bodies to find out how it has to be used and what it does.