Trivial doc error in %g format.

jcc7 jcc7_member at pathlink.com
Mon Mar 20 10:31:10 PST 2006


In article <dvm7a3$2knd$1 at digitaldaemon.com>, Don Clugston says...
>
>in std_format.html:
>
>under 'g','G':
>
>"The Precision specifies the number of significant digits, and defaults 
>to one."
>
>Actually it defaults to six. Presumably this is just a typo.
>
>BTW, based on what other people are doing, I'm assuming that 
>documentation errors should only go into the ng, not into Bugzilla. Is 
>this correct?

I would usually just add a comment to the wiki page for something relatively
small like this, but we haven't been able to confirm how often Walter has time
to review the comments.

I went ahead and added a comment on this at 
http://www.prowiki.org/wiki4d/wiki.cgi?DocComments/Phobos/StdFormat since it
might be helpful for someone else down the line, and it gives Walter another
chance to see the error.

Also, I added an example since it wasn't clear to me what the problem was at
first (I figured it out eventually):
http://trac.dsource.org/projects/tutorials/wiki/WritefLnWithFloatExample

>(If Bugzilla, I think that there should be a seperate category for doc 
>errors. By definition, they are never OS/Platform dependent, and they 
>shouldn't normally appear in the changelog. Or should they always be 
>entered as trivial?)

Often, the problem is that you don't know if Walter intends it to work as
documented or as it's implemented. In this case, a default of 6 digits of
precision makes more sense to me, but perhaps the docs are correct and the code
is at fault. And when there's doubt whether the docs are the problem, it doesn't
have to be trivial.

On the other hand, a misspelled word or a run-on sentence that would be trivial
(and not too controversial). But I think those would be more appropriate for
just adding a comment to the wiki anyway.

jcc7



More information about the Digitalmars-d-bugs mailing list