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 problems/typos in the ocaml doc #8336
Comments
Comment author: administrator Formatting error of the Scanf.fscanf comment is fixed in CVS.
|
Comment author: administrator constr: fixed |
Comment author: @damiendoligez As of 3.12.1, the error message is fixed, and the sources of the documentation are available at: http://caml.inria.fr/cgi-bin/viewvc.cgi/ocamldoc/ That leaves us with one problem in the web site: the documentation link for the previous release is still wrong (should be removed). |
Comment author: @protz r12103 removes the link to the online documentation from the "previous release" page better naming for type variables has been implemented by Jacques |
Original bug ID: 1893
Reporter: administrator
Assigned to: @protz
Status: closed (set by @xavierleroy on 2013-08-31T10:46:27Z)
Resolution: fixed
Priority: normal
Severity: feature
Fixed in version: 3.13.0+dev
Category: ~DO NOT USE (was: OCaml general)
Related to: #3830 #4292
Monitored by: "Hendrik Tews"
Bug description
Hi,
I found the following pecularities/problems/typos in the ocaml
documentation:
I think in the rule for constr capitalized-ident should be replaced
with constr-name
there is a comma missing in the operator precedence table in
manual015.html after assert
exceptions should be mentioned as belonging to the name space of
constructors
instance variables are missing in the capitalization summary
table in manual011.html
[] is a constr-name, so it should be possible to use it
in a variant type definition. However,
type x = false | [];;
yields a syntax error. This works well for the other peculiar
constr-name's like (), :: ...
format and format4 have been mixed up in manual033.html
there is a formatting error in libref/Scanf.html below fscanf
there are wrong parenthesis in a number of variant types and
exceptions, eg.
Dynlink.Linking_error of (string * linking_error)
Unix.ADDR_INET of (inet_addr * int)
Unix.Unix_error of (error * string * string)
the meta symbols label and optlabel are never used, instead
?label-name and ~label-name are used. Except for the rule of
class-type, which uses label.
I have a few other remarks:
the "viewed online" link on the 3.06 distribution page points to the
3.07 docs
for the following input
class ['a] x a = object method m x = (a : 'a) end
ocaml produces
Some type variables are unbound in this type:
class ['a] x : 'a -> object method m : 'b -> 'a end
The method m has type 'a -> 'b where 'a is unbound
The last statement is wrong. The codomain of m is 'a and 'a is not
unbound.
some time ago I asked for putting the sources of the ocaml
documentation online. Having access to the sources would really
simplify the generation of the enhanced ocaml docs. Can you
reconsider this question?
Bye,
Hendrik
The text was updated successfully, but these errors were encountered: