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

404 and canonical #1324

Open
panglesd opened this issue Mar 4, 2025 · 0 comments
Open

404 and canonical #1324

panglesd opened this issue Mar 4, 2025 · 0 comments

Comments

@panglesd
Copy link
Collaborator

panglesd commented Mar 4, 2025

As reported by @lukemaurer:

Getting a 404 out of a pretty simple issue with @canonical. The repro case is pleasingly small, if janky (compiled as library.ml):

(** @canonical Library.Submodule *)
module Submodule_ = struct
  module Export = struct end
end

module Submodule = Submodule_.Export

The odoc3 beta gives a page that says

module Submodule = Submodule.Export

(note that the double underscore is gone) but the link goes to /Library/Submodule_/Export/Export/index.html which is a 404 (extra Export).
This also works with Submodule_ renamed to Submodule__ (in which case of course Export and Export/Export are both wrong).
Obviously that @canonical is wrong, but there's not much of a way around it (it's generated by Dune). I imagine the best we can do is render it as a broken reference?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant