| View Issue Details [ Jump to Notes ] | [ Issue History ] [ Print ] |
| ID | Project | Category | View Status | Date Submitted | Last Update |
| 0005310 | OCaml | OCaml general | public | 2011-07-07 12:02 | 2012-04-08 19:22 |
|
| Reporter | rbonichon | |
| Assigned To | doligez | |
| Priority | normal | Severity | tweak | Reproducibility | always |
| Status | closed | Resolution | fixed | |
| Platform | | OS | | OS Version | |
| Product Version | 3.12.0 | |
| Target Version | | Fixed in Version | 4.00.0+dev | |
|
| Summary | 0005310: Ratio.create_ratio and Ratio.create_normalized_ratio have behaviors that can be seen as misleading |
| Description | In (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 Information | The referred behavior can be instrumented with the attached ml file. |
| Tags | No tags attached. |
|
| Attached Files |  foo.ml [^] (762 bytes) 2011-07-07 12:02 |
|
Relationships 
Relationships 