Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0005310OCaml~DO NOT USE (was: OCaml general)public2011-07-07 12:022012-04-08 19:22
Assigned Todoligez 
PlatformOSOS Version
Product Version3.12.0 
Target VersionFixed in Version4.00.0+dev 
Summary0005310: Ratio.create_ratio and Ratio.create_normalized_ratio have behaviors that can be seen as misleading
DescriptionIn (undocumented) Ratio module:

* create_ratio normalizes its ratio at create time (and possibly sets normalized to true)
* create_normalized_ratio does not (it supposes it creates something normalized).

I would have expected the exact contrary to happen (normalized_ratio should normalize and create should not).

If you feel the current naming is appropriate, could you at least document the implemented behavior of these functions in the interface of ratio?

(And while you are at it, have ocamldoc generate a html file for this module too, because it is isconcerting to browse the doc of the num library and see this Ratio module appears without documentation).
Additional InformationThe referred behavior can be instrumented with the attached ml file.
TagsNo tags attached.
Attached Files? file icon [^] (762 bytes) 2011-07-07 12:02 [Show Content]

- Relationships
related to 0004866closed Module Ratio 

-  Notes
rbonichon (reporter)
2011-07-07 12:10

Ratio.create_ratio normalizes only when the appropriate "normalize_ratio_flag" is set to true.
doligez (administrator)
2012-04-01 00:15

Added comments to Ratio.mli in 4.00 (commit 12301) and trunk (commit 12304).

Generate the html file in the doc (commit 12302).

- Issue History
Date Modified Username Field Change
2011-07-07 12:02 rbonichon New Issue
2011-07-07 12:02 rbonichon File Added:
2011-07-07 12:10 rbonichon Note Added: 0006042
2012-03-26 16:19 lefessan Assigned To => doligez
2012-03-26 16:19 lefessan Status new => assigned
2012-04-01 00:15 doligez Note Added: 0007254
2012-04-01 00:15 doligez Status assigned => closed
2012-04-01 00:15 doligez Resolution open => fixed
2012-04-01 00:15 doligez Fixed in Version => 4.00.0+dev
2012-04-08 19:22 xleroy Relationship added related to 0004866
2017-02-23 16:36 doligez Category OCaml general => -OCaml general
2017-03-03 17:55 doligez Category -OCaml general => -(deprecated) general
2017-03-03 18:01 doligez Category -(deprecated) general => ~deprecated (was: OCaml general)
2017-03-06 17:04 doligez Category ~deprecated (was: OCaml general) => ~DO NOT USE (was: OCaml general)

Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker