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

Minor Ephemeron documentation fixes #7604

Closed
vicuna opened this issue Aug 16, 2017 · 6 comments

Comments

Projects
None yet
2 participants
@vicuna
Copy link

commented Aug 16, 2017

Original bug ID: 7604
Reporter: miod
Assigned to: @Octachron
Status: resolved (set by @gasche on 2017-08-16T11:20:42Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 4.05.0
Fixed in version: 4.06.0 +dev/beta1/beta2/rc1
Category: documentation
Monitored by: @gasche

Bug description

pdf 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.

File attachments

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 16, 2017

Comment author: @Octachron

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.

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 16, 2017

Comment author: miod

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!

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 16, 2017

Comment author: @Octachron

Thanks for the report! Under which name do you wish the fix to be credited?

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 16, 2017

Comment author: miod

Oh, I thought the Mantis real names were public. My name is Miod Vallat.

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 16, 2017

Comment author: @Octachron

Github PR submitted: #1292

@vicuna

This comment has been minimized.

Copy link
Author

commented Aug 16, 2017

Comment author: @gasche

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

@vicuna vicuna closed this Aug 16, 2017

@vicuna vicuna added the bug label Mar 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.