On 09/27/2018 01:23 PM, Raffaello Giulietti wrote:

> In principle I agree with you.
> 
> However, in this case the maths underlying the algorithm to select the 
> decimal are too involved to explain in comment form. I'm in the course 
> of preparing a paper that explains the idea and the details. Then it 
> should be easier to make sense out of the code.

In which case, the code must contain pointers to the relevant parts of
the paper.

> Since to my knowledge the algorithm is novel, it will require some time 
> for me to translate in paper form.

Sure, but how do you expect anyone to review your code without the
necessary explanation? Do you think that people should approve your
patch without that paper?

> There are some succinct comments here that explain the expected
> results.  I'm not the kind of programmer that comments every line
> since here the mechanics is simple enough to follow in Java
> directly. A good explanation would either be mathematical, which
> requires better typography than US-ASCII, or some explanatory
> drawings.

Sure, these can be offline somewhere. The difficulty is always the
mapping from the mathematics onto the Java code, and this is what must
be explained in the comments.

-- 
Andrew Haley
Java Platform Lead Engineer
Red Hat UK Ltd. <https://www.redhat.com>
EAC8 43EB D3EF DB98 CC77 2FAD A5CD 6035 332F A671

Reply via email to