Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0005712OCamlOCaml documentationpublic2012-08-02 11:352014-07-16 20:20
ReporterHendrik Tews 
Assigned To 
PrioritynormalSeveritytextReproducibilityalways
StatusconfirmedResolutionopen 
PlatformOSOS Version
Product Version4.00.0 
Target Version4.03.0+devFixed in Version 
Summary0005712: some documentation problems
DescriptionThis is the usual bug report about problems that I found while
preparing the enhanced OCaml documentation. The list is shorter
than for previous versions. Congratulations!

1- ``??'' is not accepted as prefix-symbol, although it is
   permitted by the grammar

2- the meta symbol ``label-name'' is defined twice, in 6.3 and 6.1

3- ``#load_rec "camlp4o.cma";;'' fails in the usual way, although
   the documentation says it should load dynlink recursively.

4- the default set of enabled warnings for ocamlopt has changed,
   the documentation still contains the old one

5- ``Format.printf "@%" does not print a ``%'' as documented

6- OCAMLRUNPARAM flag R is not documented

7- String.{iteri,map} are missing in the documentation of StdLabels
   (in file /libref/StdLabels.String.html)

8- ArrayLabels, ListLabels, StringLabels are missing in the txt
   version of the documentation

9- new option -bin-annot is not documented

Bye,

Hendrik
TagsNo tags attached.
Attached Files

- Relationships
parent of 0005720resolved #load_rec fails on camlp4o.cma 

-  Notes
(0007899)
doligez (administrator)
2012-08-06 14:00

For (1): this is just like "|" or "let": it's listed in the Keywords section, and cannot be used as an identifier.

For (2): the two definitions are equivalent. I have removed the one in 6.3 and put a pointer to 6.1.

For (3): looks like a bug in the code rather than the documentation. I've filed a separate bug report.

For (4): wrong for both ocamlc and ocamlopt, but in different ways. Fixed. (r 12822)

For (5): it does, but you have to cheat the type system in order to give "@%" as argument to Format.printf... I've removed that from the doc. (r 12821 and r 12824)

For (6): I can't find it in the code either. What is it supposed to do?

For (7): the functions are actually missing in the module itself. Fixed. (r 12823 and r 12824)

For (8): they are not in the PDF either. I think this is on purpose.

For (9): it's not in the man pages and it's not in the reference manual. TO DO
(0007903)
Hendrik Tews (reporter)
2012-08-06 17:04

6- R is supposed to randomize hash tables, see docs for Hashtbl.

8- But these modules are in the html version! Therefore I would say they should also appear in the pdf and in the txt version.
(0008681)
doligez (administrator)
2013-01-03 16:23
edited on: 2013-01-03 16:24

(6): done in trunk (commits 13197 and 13198)


Still to do: (9) and maybe (8)

(0009753)
doligez (administrator)
2013-07-11 16:26

To do before 4.01.0: document -bin-annot.

To do later: treat ArrayLabels, ListLabels, and StringLabels consistently across all versions of the doc.
(0010211)
doligez (administrator)
2013-08-20 17:32

(9): fixed in branch 4.01 (rev 14025)
(0010717)
doligez (administrator)
2013-12-16 11:44

Note: the only remaining point is (8).

- Issue History
Date Modified Username Field Change
2012-08-02 11:35 Hendrik Tews New Issue
2012-08-06 11:35 doligez Relationship added parent of 0005720
2012-08-06 14:00 doligez Note Added: 0007899
2012-08-06 14:00 doligez Severity minor => text
2012-08-06 14:00 doligez Status new => confirmed
2012-08-06 17:04 Hendrik Tews Note Added: 0007903
2012-09-06 16:44 doligez Target Version => 4.00.1+dev
2012-09-21 15:04 doligez Target Version 4.00.1+dev => 4.00.2+dev
2013-01-03 16:23 doligez Note Added: 0008681
2013-01-03 16:24 doligez Note Edited: 0008681 View Revisions
2013-07-11 16:26 doligez Note Added: 0009753
2013-07-11 16:26 doligez Target Version 4.00.2+dev => 4.01.0+dev
2013-08-19 15:34 doligez Priority normal => urgent
2013-08-20 16:21 doligez Assigned To => doligez
2013-08-20 16:21 doligez Status confirmed => assigned
2013-08-20 17:32 doligez Note Added: 0010211
2013-08-20 17:33 doligez Assigned To doligez =>
2013-08-20 17:33 doligez Priority urgent => normal
2013-08-20 17:33 doligez Status assigned => confirmed
2013-08-20 17:33 doligez Target Version 4.01.0+dev => 4.01.1+dev
2013-12-16 11:44 doligez Note Added: 0010717
2014-05-25 20:20 doligez Target Version 4.01.1+dev => 4.02.0+dev
2014-07-16 20:20 doligez Target Version 4.02.0+dev => 4.03.0+dev


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker