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
various documentation problems #4292
Comments
Comment author: @pierreweis Points No 4, 6, 10, 11 are corrected in the working sources. Thank you for the careful review. |
Comment author: @pierreweis Points No 3 also corrected. |
Comment author: @damiendoligez 0: it is now available at http://caml.inria.fr/cgi-bin/viewvc.cgi/ocamldoc/ That leaves us with: 8 and 13 are most probably ocamldoc bugs, not sure about 9. |
Comment author: @damiendoligez 8 is fixed. It was a mistake in Scanf.mli: a missing blank line between the header comment and the module declaration meant that the header comment was the description of the module, which was properly printed after the module declaration by ocamldoc. (commits 12230 and 12231) 13 is a bug/limitation of Hevea, not ocamldoc. About 9: it's a problem that we'll have to live with. Using another notation in the .mli would make it rather unreadable. I'm closing this PR. |
Original bug ID: 4292
Reporter: Hendrik Tews
Status: closed (set by @xavierleroy on 2013-08-31T10:48:44Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 3.10.0
Fixed in version: 4.00.0+dev
Category: ocamldoc
Related to: #8336
Monitored by: @zoggy
Bug description
Some of these points are very minor, but I thought I tell
everything I spotted and let you decide...
AGAIN AND AGAIN AND AGAIN: PLEASE MAKE THE SOURCES OF THE
DOCUMENTATION AVAILABLE [or produce a manual with changes
information yourself] I am begging for this for years already!
the positional specifier for width and precision of printf
format strings is poorly described
the tar file with html version of the manual contains strange
files, eg manual.haux
the comment of UnixLabels.wait_flag refers to module Unix
type in Genarray.map_file: default->defaults
online doc pointer in
http://caml.inria.fr/ocaml/release-prev.en.html points to the
3.10 docs
in bscanf, its unclear what "bounding condition" means
format6 is missing in the builtin types
in the txt version, explanations of embedded modules are
displaced, for instance "Scanning buffers" appears as headline
after the contents of the Scanf.Scanning module
capiltal format string letters are treated as constructors:
F
the comment on Pervasives.format4 is general and should
follow the heading directly
wrong open_in in open_in_gen description
use the meta symbol class-body in class-expr
in the txt version: formatting error in the 3rd case of
variant-type
[might be a feature] some file names have changed, eg
lex.html instead of manual009.html
in the txt version, the first line of embedded output is
behind the << marker, eg
<<#1+2*3;;
<<##load "camlp4o.cma";;
Camlp4 Parsing version 3.10+dev26 (2007-04-25)
The text was updated successfully, but these errors were encountered: