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

ocamldoc lost "with type" in "include ... with type ..." #5002

Closed
vicuna opened this issue Mar 11, 2010 · 3 comments
Closed

ocamldoc lost "with type" in "include ... with type ..." #5002

vicuna opened this issue Mar 11, 2010 · 3 comments

Comments

@vicuna
Copy link

vicuna commented Mar 11, 2010

Original bug ID: 5002
Reporter: Julien Signoles
Assigned to: @zoggy
Status: assigned (set by Julien Signoles on 2010-03-11T12:17:10Z)
Resolution: open
Priority: normal
Severity: minor
Version: 3.11.1
Category: ocamldoc
Monitored by: @yakobowski

Bug description

Hello,

Consider:
=== a.ml ===
module type X = sig type t end
module type Y = sig include X with type t = int end

$ ocamldoc -html a.ml

The file A.Y.html is incorrect since the "with type" part is lost:

module type Y = sig .. end

include A.X

@vicuna
Copy link
Author

vicuna commented Mar 15, 2016

Comment author: @Armael

An other manifestation of the problem (after an include, ocamldoc only tries to print the name of the signature that is included) is when including an anonymous signature:

include sig type t = int end

is outputted as

include ??

I tried a bit to find a fix for that, but failed... :(. I would be quite happy to see this issue fixed. It's a tad annoying when one has an interface with "include"s; then there is no way to get correct documentation for it.

@github-actions
Copy link

This issue has been open one year with no activity. Consequently, it is being marked with the "stale" label. What this means is that the issue will be automatically closed in 30 days unless more comments are added or the "stale" label is removed. Comments that provide new information on the issue are especially welcome: is it still reproducible? did it appear in other contexts? how critical is it? etc.

@github-actions github-actions bot added the Stale label May 18, 2020
@Armael
Copy link
Member

Armael commented May 18, 2020

I suggest that we close the issue, as this is unlikely to be solved in ocamldoc, is solved in odoc, and ocamldoc is in progress of being replaced by odoc anyway.

@gasche gasche closed this as completed May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants