From: AdaMagica <christ-usch.grein@t-online.de>
Subject: Re: Is the Documentation In a spec File Usually Enough For You ?
Date: Mon, 15 Oct 2018 03:05:51 -0700 (PDT)
Date: 2018-10-15T03:05:51-07:00 [thread overview]
Message-ID: <45ed49eb-1849-40b3-bfae-5423fae9b164@googlegroups.com> (raw)
In-Reply-To: <7fcdcc97-67e4-473b-abc4-cd0ecd4501ad@googlegroups.com>
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.
next prev parent reply other threads:[~2018-10-15 10:05 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-15 0:42 Is the Documentation In a spec File Usually Enough For You ? patrick
2018-10-15 5:44 ` Henrik Härkönen
2018-10-15 7:22 ` Dmitry A. Kazakov
2018-10-15 7:42 ` Niklas Holsti
2018-10-15 10:05 ` AdaMagica [this message]
2018-10-15 11:25 ` patrick
2018-10-15 11:57 ` Markus Schöpflin
2018-10-15 13:02 ` patrick
2018-10-15 16:50 ` Jeffrey R. Carter
2018-10-16 9:57 ` AdaMagica
2018-10-16 16:57 ` Jeffrey R. Carter
2018-10-18 9:06 ` AdaMagica
2018-10-18 15:24 ` Brad Moore
2018-10-18 17:29 ` Jeffrey R. Carter
2018-10-18 17:54 ` AdaMagica
2018-10-18 18:50 ` Dennis Lee Bieber
2018-10-18 20:07 ` Jeffrey R. Carter
2018-10-21 15:20 ` AdaMagica
2018-10-21 18:56 ` Jeffrey R. Carter
2018-10-22 16:04 ` AdaMagica
2018-10-22 19:13 ` Jeffrey R. Carter
2018-10-23 10:00 ` AdaMagica
2018-10-18 21:24 ` Randy Brukardt
2018-10-19 7:39 ` J-P. Rosen
2018-10-20 1:27 ` Randy Brukardt
replies disabled
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox