Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0007604OCamldocumentationpublic2017-08-16 08:282017-08-16 13:20
Reportermiod 
Assigned Tooctachron 
PrioritynormalSeverityminorReproducibilityN/A
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version4.05.0 
Target VersionFixed in Version4.06.0 +dev/beta1/beta2/rc1 
Summary0007604: Minor Ephemeron documentation fixes
Descriptionpdf generated documentation for module Ephemeron has a duplicated sentence, and a word gets omitted, which causes a sentence to lose its meaning.

Suggested fix is attached.
TagsNo tags attached.
Attached Filesdiff file icon ephemeron.mli.diff [^] (960 bytes) 2017-08-16 08:28 [Show Content]

- Relationships

-  Notes
(0018171)
octachron (developer)
2017-08-16 10:32

The first fix (removing the duplicate "Ephemerons and weak hash table") seems good. For the second one, it would be better to replace "{Hashtbl.t}" with a cross-reference "{!Hashtbl.t}" rather than a code block ("[Hashtbl.t]").

After this fix, would you mind sending your patch to https://github.com/ocaml/ocaml [^] ? Otherwise, I would take care of this part.
(0018172)
miod (reporter)
2017-08-16 10:35

A cross-reference would indeed make more sense.

Please take care of sending an updated diff to github, as I no longer have a github account.

Thanks!
(0018173)
octachron (developer)
2017-08-16 10:41

Thanks for the report! Under which name do you wish the fix to be credited?
(0018174)
miod (reporter)
2017-08-16 10:45

Oh, I thought the Mantis real names were public. My name is Miod Vallat.
(0018175)
octachron (developer)
2017-08-16 11:31

Github PR submitted: https://github.com/ocaml/ocaml/pull/1292 [^]
(0018181)
gasche (administrator)
2017-08-16 13:20

Fixed using the proposed patch (through the github PR), thanks!

- Issue History
Date Modified Username Field Change
2017-08-16 08:28 miod New Issue
2017-08-16 08:28 miod File Added: ephemeron.mli.diff
2017-08-16 10:32 octachron Note Added: 0018171
2017-08-16 10:34 octachron Assigned To => octachron
2017-08-16 10:34 octachron Status new => assigned
2017-08-16 10:35 miod Note Added: 0018172
2017-08-16 10:41 octachron Note Added: 0018173
2017-08-16 10:45 miod Note Added: 0018174
2017-08-16 11:31 octachron Note Added: 0018175
2017-08-16 13:20 gasche Note Added: 0018181
2017-08-16 13:20 gasche Status assigned => resolved
2017-08-16 13:20 gasche Fixed in Version => 4.06.0 +dev/beta1/beta2/rc1
2017-08-16 13:20 gasche Resolution open => fixed


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker