Not yet approved library documentation mark
Hi, I am new to Boost libraries, and each so often I look for some functionality that might be implemented in a Boost library --logging, exception, ...-- some of the libraries that I want are still in work (logging) or pending approval (exception), but it does not seem easy to detect this from the docs. I believe that requiring all proposals' documentation to have a reference to its current review state would be interesting while not time demanding for the developers. What I am proposing is that in any and all not-yet-approved library that is proposed to boost the docs (ideally close to the title) document the status, for example in http://www.revergestudios.com/boost-exception/boost-exception.htm title could read: Boost Exception [pending approval] or something alike. David
David Rodríguez Ibeas wrote:
What I am proposing is that in any and all not-yet-approved library that is proposed to boost the docs (ideally close to the title) document the status, for example in http://www.revergestudios.com/boost-exception/boost-exception.htm title could read:
What's wrong with simply checking whether you're on the www.boost.org domain or not? If you can't find the docs for the library there, it's not in any released Boost version. That said, I'm pretty sure this is already a requirement. Sebastian Redl
Question is that there are some libraries that have been approved for next release, but that are not in the current release (1.34), some are in SVN (Generic Image Library, Bimap,...), some not even there (binary_int might be an example). The total amount of such libraries, as listed in http://www.boost.org/more/formal_review_schedule.html is up to 15, not including those that are accepted provisionally. I am currently checking in the above link, but I would rather have a comment in the library docs. David On 10/31/07, Sebastian Redl <sebastian.redl@getdesigned.at> wrote:
David Rodríguez Ibeas wrote:
What I am proposing is that in any and all not-yet-approved library that is proposed to boost the docs (ideally close to the title) document the status, for example in http://www.revergestudios.com/boost-exception/boost-exception.htm title could read:
What's wrong with simply checking whether you're on the www.boost.org domain or not? If you can't find the docs for the library there, it's not in any released Boost version.
That said, I'm pretty sure this is already a requirement.
Sebastian Redl _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
David Rodríguez Ibeas wrote:
Question is that there are some libraries that have been approved for next release, but that are not in the current release (1.34), some are in SVN (Generic Image Library, Bimap,...), some not even there (binary_int might be an example). The total amount of such libraries, as listed in http://www.boost.org/more/formal_review_schedule.html is up to 15, not including those that are accepted provisionally. I am currently checking in the above link, but I would rather have a comment in the library docs.
http://www.boost.org/libs/libraries.htm This is the documentation for the libraries that are in the current Boost release (1.34.1). Any documentation found elsewhere is either a duplicate of this official resource, or it's not in the Boost release. I don't see where the problem is. Sebastian Redl
-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of Sebastian Redl Sent: 31 October 2007 19:36 To: boost@lists.boost.org Subject: Re: [boost] Not yet approved library documentation mark
David Rodríguez Ibeas wrote:
Question is that there are some libraries that have been approved for next release, but that are not in the current release (1.34), some are in SVN (Generic Image Library, Bimap,...), some not even there (binary_int might be an example). The total amount of such libraries, as listed in http://www.boost.org/more/formal_review_schedule.html is up to 15, not including those that are accepted provisionally. I am currently checking in the above link, but I would rather have a comment in the library docs.
http://www.boost.org/libs/libraries.htm
This is the documentation for the libraries that are in the current Boost release (1.34.1). Any documentation found elsewhere is either a duplicate of this official resource, or it's not in the Boost release. I don't see where the problem is.
One problem is that there are lots of completed and fully functional libraries that are not in the current release, as noted by David Rodríguez Ibeas, and it's not obvious enough where to find them. Another factor is that an important way of improving quality is to get feedback from 'real-life' use of upcoming libraries, including those that have been reviewed and approved, as well as those that are candidates for review, and potential candidates too. Even after the rigors of review, all libraries have bad 'features'. So, to get more feedback, I think we need to give much better indications about stuff that is 'seriously worth looking at', if not yet 'official'. Comments about current development status would really useful, even if it says 'still needs work'. Paul --- Paul A Bristow Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB +44 1539561830 & SMS, Mobile +44 7714 330204 & SMS pbristow@hetp.u-net.com
On 31/10/2007, David Rodríguez Ibeas <dibeas@ieee.org> wrote:
<snip>
What I am proposing is that in any and all not-yet-approved library that is proposed to boost the docs (ideally close to the title) document the status, for example in http://www.revergestudios.com/boost-exception/boost-exception.htm title could read:
One really simple way to achieve this is to modify the image that appears on the top-left of the docs. Some people on the 'net have 'Not yet' red stamps plastered over that image, which works very nicely IMO. If boost had a few variants of the image - for instance, pending, under-review, accepted, next-release - then accepted libraries could point to the relevant image using for example: boostbook standalone : generated_docs_xml_target : <xsl:param>boost.image.src=http://boost.org/images/logo_pending.png ; Where logo_pending.png (doesn't exist yet) would have 'pending' stamped on the image. Regards, Darren
participants (4)
-
Darren Garvey -
David Rodríguez Ibeas -
Paul A Bristow -
Sebastian Redl