You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Original bug ID: 7415 Reporter: william Status: resolved (set by @Octachron on 2016-12-06T22:28:46Z) Resolution: open Priority: normal Severity: text Version: 4.04.0 Category: documentation
Bug description
Hello,
in 4.04, looking at the standard library, there are many undocumented modules, or modules written with very specific language. Maybe it would be nice to document them better so that we can use them ? At least, explain the purpose of the module in understandable language, so that if we think we are concerned by that module we start to look for complementary documentation on the web. Or say it is for internal ocaml purposes and that it is unlikely to be reused. Without it I don't even know if I could benefit from the module.
Arg_helper ?
.Arith_status not mentionned in Floating-point arithmetic documentation
Ast* ? + make link to Builtin_attributes ?
Builtin_attributes : rename in Ast_builtin_attributes ?
Attr_helper : rename in Ast_attr_helper ?
Ccomp ?
Condition : to group with Thead or ThreadUnix ?
Config ?
Consistbl ?
ArrayLabels, ListLabels to be moved in StdLabels ?
MoreLabels to mark as deprecated ?
Strongly_connected_components ?
Tbl ?
Terminfo ?
etc...
Best regards
The text was updated successfully, but these errors were encountered:
however, maybe the documentation for standard library could benefit for some precision :
" Module Set: sets over ordered types (deprecated) "
=> is it to be replaced by Map ?
The possible confusion due to the hidden module name for Sort has been fixed in #921 which restores the module name and move the deprecated comment to the module description.
Original bug ID: 7415
Reporter: william
Status: resolved (set by @Octachron on 2016-12-06T22:28:46Z)
Resolution: open
Priority: normal
Severity: text
Version: 4.04.0
Category: documentation
Bug description
Hello,
in 4.04, looking at the standard library, there are many undocumented modules, or modules written with very specific language. Maybe it would be nice to document them better so that we can use them ? At least, explain the purpose of the module in understandable language, so that if we think we are concerned by that module we start to look for complementary documentation on the web. Or say it is for internal ocaml purposes and that it is unlikely to be reused. Without it I don't even know if I could benefit from the module.
Arg_helper ?
.Arith_status not mentionned in Floating-point arithmetic documentation
Ast* ? + make link to Builtin_attributes ?
Builtin_attributes : rename in Ast_builtin_attributes ?
Attr_helper : rename in Ast_attr_helper ?
Ccomp ?
Condition : to group with Thead or ThreadUnix ?
Config ?
Consistbl ?
ArrayLabels, ListLabels to be moved in StdLabels ?
MoreLabels to mark as deprecated ?
Strongly_connected_components ?
Tbl ?
Terminfo ?
etc...
Best regards
The text was updated successfully, but these errors were encountered: