ocaml / ocaml/odoc

Unable to refer to some elements in unapplied functors

Open
#882 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug cross-referencer
Dominant language
OCaml
Stars
355
Forks
114
Avg merge
6d 21h
Merged PRs (30d)
10

Description

For example:

module X : functor ( Y : sig type t end ) -> sig
	module Z = Y
end

(** {!X.Z.t} *)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the OCaml snippet in the report and trace how odoc resolves the reference {!X.Z.t} when X is an unapplied functor. Done means the reference to the nested type resolves successfully and the relevant documentation checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.