0001893: various problems/typos in the ocaml doc - MantisBT

Mantis Bug Tracker

View Issue Details [ Jump to Notes ]

[ Issue History ] [ Print ]

ID

Project

Category

View Status

Date Submitted

Last Update

0001893

OCaml

OCaml general

public

2003-10-24 23:13

2012-02-07 14:08

Reporter

administrator

Assigned To

protz

Priority

normal

Severity

feature

Reproducibility

always

Status

resolved

Resolution

fixed

Platform

OS

OS Version

Product Version

Target Version

Fixed in Version

3.13.0+dev

Summary

0001893: various problems/typos in the ocaml doc

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

Tags

No tags attached.

Relationships

related to	0003830	closed	garrigue	various problems with ocaml 3.09 and the docs
related to	0004292	resolved		various documentation problems

Notes
(0000186) administrator (administrator) 2004-03-22 16:04	Formatting error of the Scanf.fscanf comment is fixed in CVS. OCamldoc was fixed not to put parenthesis around arguments of variant constructors and exceptions. - Maxence

(0000187) administrator (administrator) 2004-06-28 17:00	constr: fixed comma: fixed exceptions: fixed instance variables: fixed []: fixed format: fixed scanf: fixed OCamldoc was fixed not to put parenthesis around arguments of variant constructors and exceptions. - Maxence label/optlabel: fixed broken link: feature wish: should remove the link; we don't keep old versions of the doc on-line wrong error message: feature wish: better naming of type variables in system messages documentation sources: feature wish

(0006820) doligez (manager) 2012-01-27 09:41	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).

(0006847) protz (manager) 2012-01-30 16:38	r12103 removes the link to the online documentation from the "previous release" page better naming for type variables has been implemented by Jacques

Issue History
Date Modified	Username	Field	Change
2005-11-18 10:13	administrator	New Issue
2007-11-19 22:25	doligez	Relationship added	related to 0003830
2012-01-27 09:41	doligez	Note Added: 0006820
2012-01-30 16:38	protz	Note Added: 0006847
2012-01-30 16:38	protz	Status	acknowledged => resolved
2012-01-30 16:38	protz	Fixed in Version	=> 3.13.0+dev
2012-01-30 16:38	protz	Resolution	open => fixed
2012-01-30 16:38	protz	Assigned To	=> protz
2012-02-07 14:08	doligez	Relationship added	related to 0004292

Copyright © 2000 - 2011 MantisBT Group