Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update ocaml documentation #7415

Closed
vicuna opened this issue Nov 16, 2016 · 4 comments
Closed

update ocaml documentation #7415

vicuna opened this issue Nov 16, 2016 · 4 comments

Comments

@vicuna
Copy link

vicuna commented Nov 16, 2016

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

@vicuna
Copy link
Author

vicuna commented Nov 16, 2016

Comment author: william

as explained in next bug report, I made a bad google search and looked at http://caml.inria.fr/pub/docs/manual-ocaml/libref/index.html
instead of :
http://caml.inria.fr/pub/docs/manual-ocaml/stdlib.html

sorry for this.

@vicuna
Copy link
Author

vicuna commented Nov 16, 2016

Comment author: william

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 ?

@vicuna
Copy link
Author

vicuna commented Nov 16, 2016

Comment author: @Octachron

The deprecated module here is the Sort module, not Set.
The documentation may be unclear here.

@vicuna
Copy link
Author

vicuna commented Dec 6, 2016

Comment author: @Octachron

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant