Convert library review manager result
This is my analysis of the 'convert' library review and the result
of whether the convert library should be accepted into Boost.
Please read the entire analysis to understand my reasoning before
reading the result.
I would like to thank all of those who took part in the review and made
comments. This includes Julian Gonggrip, Rob Stewart, Andrzej Krzemienski,
Matus Chochlik, Jeroen Habraken, Erik Nelson, Hartmut Kaiser, Joel De
Guzman,
Thijs (M.A.) van den Berg, Roland Bock, Gavin Lambert, feverzsj, Paul
Bristow,
and alex. If I have missed anybody I do apologize. All comments were taken
into account and all comments were intelligent and to the point.
Naturally I would also like to than Vladimir Batov for patiently answering
all comments and explaining and defending his library and his design
decisions.
For the most part I am going to focus on general issues rather than on the
individuals who made them.
Documentation issues:
The documentation was too focused on explaining the
library as it differed from lexical_cast. Vladimir Batov explained why
this is so but I also agree that the documentation can be better by simply
focusing on what the library provides in terms of functionality. Comments
also mentioned that the current converters are not documented as well as
the could be, and some commenters reflected that knowledge of how a
particular
converter works, including possible failures using that converter,
is also needed despite the common library interface.
The documentation did not provide enough information
about the use of locales in the library.
The reference section was very limited with not enough explanation. A
reference
built from doxygen comments in the source files would be better.
A better explanation or example in the documentation for writing one's own
converter was suggested.
Although the Performance section in the documentation was fairly lengthy
some commenters wanted to know why some things could not be tested.
Others wanted
more information about how convert performance compared to other
convert-like
implementations.
In general I think most reviewers found the documentation adequate for
understanding how to use the library but lacking in completeness. Vladimir
Batov reflected that if the library were accepted into Boost he would then
create more complete documentation and the above issues could be addressed.
Implementation issues:
As in most reviews most commenters did not look very deeply into the actual
code but were happy to know how to use the library, and this is
understandable
for a review. There were a few pertinent comments however and I am just
going
to enumerate them.
All macros should be prefix with BOOST_. My own addition to that is that all
macros should be prefixed with BOOST_CONVERT_ to avoid any conflicts
with other
libraries.
There should be a jamfile for running the tests. Also some full-blown
examples
of using the library in a simple program, along with the appropriate
jamfile,
would be helpful.
Source code should contain spaces, not tabs. This is an easily fixed
minor issue.
As mentioned before doxygen comments in the public source are the usual
Boost
way of doing things.
The main header file should be convert.hpp instead of api.h.
Some includes were missing from the printf converter.
Design issues:
In the design of the library is where we have the most varying views.
The major
issue in discussing the design of the library for those who felt it was
inadequate
were the comments that using the library was too complicated, that the
central
function for invoking a conversion should be simpler to use. While all
suggestions
were well-argued I felt that a number of these differences were merely
syntactical
issues rather than issues that made the functionality easier to use. The
main
interface for using the library is:
convert
-- View this message in context: http://boost.2283326.n4.nabble.com/Convert-library-review-manager-result-tp4... Sent from the Boost - Dev mailing list archive at Nabble.com.
Edward Diener-3 wrote
This is my analysis of the 'convert' library review and the result of whether the convert library should be accepted into Boost. Please read the entire analysis to understand my reasoning before reading the result.
I would like to thank all of those who took part in the review and made comments. This includes Julian Gonggrip, Rob Stewart, Andrzej Krzemienski, Matus Chochlik, Jeroen Habraken, Erik Nelson, Hartmut Kaiser, Joel De Guzman, Thijs (M.A.) van den Berg, Roland Bock, Gavin Lambert, feverzsj, Paul Bristow, and alex. If I have missed anybody I do apologize. All comments were taken into account and all comments were intelligent and to the point. ...
I would like to thank Edward for taking on the difficult and time-consuming role of the Review Manager for "convert" and for his thorough analysis, continuous support and encouragement. It's very much and truly appreciated. Also I'd like to thank everyone who contributed to the discussion and to apologize if during the review my responses might have come across as impolite, harsh or anything of that sort. That was never my intention. Communicating in a foreign language is never an easy thing to begin with... it's much harder under stress/pressure (real or imagined). I would also like to reiterate that I by no means consider this "convert"-related work done. Far from it. I personally always saw my submission as more of an invitation for discussion and further work in this conversion-related area which, in my view, has been unduly neglected. I am very happy that Jeroen, Roland and Rob kindly agreed to try and work together and to improve this original submission. Many more people contributed their views and opinions. If you would like to contribute to the work and to see the result more to their liking, please do not hesitate to say so. Alex, yes, I am looking at you in particular. :-) You've been contributing to the signature of the converter but then fell off the radar. Please come back. Thank you everyone and with our collective effort I am hoping to see "convert" better shortly. -- View this message in context: http://boost.2283326.n4.nabble.com/Convert-library-review-manager-result-tp4... Sent from the Boost - Dev mailing list archive at Nabble.com.
] Convert library review manager result
Edward Diener-3 wrote
This is my analysis of the 'convert' library review and the result of whether the convert library should be accepted into Boost. Please read the entire analysis to understand my reasoning before reading the result.
I would like to thank Edward for taking on the difficult and time-consuming role of the Review Manager for "convert" and for his thorough analysis, continuous support and encouragement. It's very much and truly appreciated.
Congratulation for getting the library accepted! I think Edward made a wise decision because you can now finalize the library using your best judgement rather than trying to please everybody at the same time.
Many more people contributed their views and opinions. If you would like to contribute to the work and to see the result more to their liking, please
do
not hesitate to say so. Alex, yes, I am looking at you in particular. :-) You've been contributing to the signature of the converter but then fell off the radar. Please come back.
I was still following the discussions but felt that you understood my viewpoint and was confident you would take it into account when making final decisions about the shape of your library. Best wishes, Alex
Edward Diener wrote:
This is my analysis of the 'convert' library review and the result of whether the convert library should be accepted into Boost. Please read the entire analysis to understand my reasoning before reading the result.
Thank you for the thorough labour.
[...] Julian Gonggrip, [...]
It seems you have missed the second 'j' in my name (twice). No offence taken though!
My decision, based on the votes as I interpret them, is that the convert library is ACCEPTED into Boost.
Congratulations, Vladimir! -Julian
On 6/3/2014 11:51 AM, Julian Gonggrijp wrote:
Edward Diener wrote:
This is my analysis of the 'convert' library review and the result of whether the convert library should be accepted into Boost. Please read the entire analysis to understand my reasoning before reading the result.
Thank you for the thorough labour.
[...] Julian Gonggrip, [...]
It seems you have missed the second 'j' in my name (twice). No offence taken though!
You are right ! I overlooked it when recording your name in my notes for the review and then used that incorrect last name each time.
My decision, based on the votes as I interpret them, is that the convert library is ACCEPTED into Boost.
Congratulations, Vladimir!
participants (4)
-
alex
-
Edward Diener
-
Julian Gonggrijp
-
Vladimir Batov