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

some documentation problems #5712

Closed
vicuna opened this issue Aug 2, 2012 · 8 comments
Closed

some documentation problems #5712

vicuna opened this issue Aug 2, 2012 · 8 comments
Assignees
Milestone

Comments

@vicuna
Copy link

@vicuna vicuna commented Aug 2, 2012

Original bug ID: 5712
Reporter: Hendrik Tews
Assigned to: @garrigue
Status: resolved (set by @garrigue on 2017-02-24T10:17:38Z)
Resolution: fixed
Priority: normal
Severity: text
Version: 4.00.0
Target version: 4.05.0 +dev/beta1/beta2/beta3/rc1
Fixed in version: 4.05.0 +dev/beta1/beta2/beta3/rc1
Category: documentation
Parent of: #5720
Monitored by: @lefessan @glondu @hcarty

Bug description

This 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

@vicuna
Copy link
Author

@vicuna vicuna commented Aug 6, 2012

Comment author: @damiendoligez

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

@vicuna
Copy link
Author

@vicuna vicuna commented Aug 6, 2012

Comment author: Hendrik Tews

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.

@vicuna
Copy link
Author

@vicuna vicuna commented Jan 3, 2013

Comment author: @damiendoligez

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

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

@vicuna
Copy link
Author

@vicuna vicuna commented Jul 11, 2013

Comment author: @damiendoligez

To do before 4.01.0: document -bin-annot.

To do later: treat ArrayLabels, ListLabels, and StringLabels consistently across all versions of the doc.

@vicuna
Copy link
Author

@vicuna vicuna commented Aug 20, 2013

Comment author: @damiendoligez

(9): fixed in branch 4.01 (rev 14025)

@vicuna
Copy link
Author

@vicuna vicuna commented Dec 16, 2013

Comment author: @damiendoligez

Note: the only remaining point is (8).

@vicuna
Copy link
Author

@vicuna vicuna commented Feb 17, 2017

Comment author: @damiendoligez

#1049

@vicuna
Copy link
Author

@vicuna vicuna commented Feb 24, 2017

Comment author: @garrigue

Merged #1049.

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

Successfully merging a pull request may close this issue.

None yet
2 participants