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

unexpected warnings when including signature #7606

Closed
vicuna opened this issue Aug 17, 2017 · 5 comments
Closed

unexpected warnings when including signature #7606

vicuna opened this issue Aug 17, 2017 · 5 comments

Comments

@vicuna
Copy link

vicuna commented Aug 17, 2017

Original bug ID: 7606
Reporter: kosik
Status: confirmed (set by @Octachron on 2017-08-17T13:10:35Z)
Resolution: open
Priority: normal
Severity: feature
Version: 4.05.0
Category: ocamldoc
Has duplicate: #7607

Bug description

I have noticed that ocamldoc sometimes generates unexpected warnings.

E.g. if I have "main.mli" file with the following contents:

include module type of struct end

and I type the following command:

ocamlfind doc -html main.mli

then ocamldoc will generate the following warning:

Warning: Module or module type ?? not found

I would say that this is not expected because the "main.mli" file itself is a valid Ocaml *.mli file that compiles without any problems.

Steps to reproduce

tar xvzf 0.tar.gz
cd 0
make

File attachments

@vicuna
Copy link
Author

vicuna commented Aug 17, 2017

Comment author: @Octachron

Ocamldoc support for both including module types and "module type of" is limited. The warnings are indeed spurious, but removing it would require a lot of work on ocamldoc. Ongoing work on codoc (https://github.com/dsheets/codoc) may fix this issue at an earlier point.

@vicuna
Copy link
Author

vicuna commented Aug 17, 2017

Comment author: kosik

Is anybody maintaining ocamldoc actively or is it something that is being "phased out"?

@vicuna
Copy link
Author

vicuna commented Aug 17, 2017

Comment author: @Octachron

As far as I know, there are no active development on ocamldoc currently; but ocamldoc is still maintained.

@vicuna
Copy link
Author

vicuna commented Aug 18, 2017

Comment author: @lpw25

Note that it is odoc (https://github.com/ocaml-doc/odoc) that has ongoing work. Codoc was an earlier prototype.

@github-actions
Copy link

github-actions bot commented May 7, 2020

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 7, 2020
@github-actions github-actions bot closed this as completed Jun 8, 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

1 participant