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 uses the same namespace for [module] and [module type]. #4366

Closed
vicuna opened this issue Aug 19, 2007 · 1 comment
Closed

Ocamldoc uses the same namespace for [module] and [module type]. #4366

vicuna opened this issue Aug 19, 2007 · 1 comment

Comments

@vicuna
Copy link

vicuna commented Aug 19, 2007

Original bug ID: 4366
Reporter: jm
Assigned to: @zoggy
Status: closed (set by @zoggy on 2007-11-12T08:42:14Z)
Resolution: won't fix
Priority: normal
Severity: major
Version: 3.10+dev
Category: ocamldoc
Monitored by: jm

Bug description

% cat file.ml
module type M =
sig
type t
end
module M =
struct
end
% <calls to ocamlc/ocamldoc>
% ls doc/html/File.*
doc/html/File.html doc/html/File.M.html

File.M.html contains the documentation for [module type] M,
the documentation for [module] M is nowhere,
and links for it point to the documentation of [module type] M.

@vicuna
Copy link
Author

vicuna commented Nov 12, 2007

Comment author: @zoggy

Indeed. But having two different ways of naming html files for module and module type makes html linking very hard, for example in function types: the generator has to know whether each type absolute name refer to a type in a module or a module name, if both exists. This complicates the code a lot. By the way, I'm not convinced that having a module type and a module with the same name is a good choice, since they refer to two different things.
So I keep the current implementation.

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