Open dsheets opened 9 years ago
This is an interesting variation on #15. It seems that we would like self-reference to subcomponents to be highest priority but self-reference to the same definition to be lowest priority.
I think the rules for the second case work ok. As far as I understand them, the path is searched ancestor-ward starting with self.
I don't understand why the first case is different as I thought both resulted in an annotation node on the same signature item (M
).
I think that the second one is a stand-alone comment within M
rather than it's description. I think that only the top-level modules treat the first comment specially. To be honest I can't actually remember whether this is the case, nor whether this is what ocamldoc currently implements, but I think it is probably the right implementation.
This affects documentation of cmdliner.
is scoped to the container but
is scoped to the child,
M
.See also dsheets/ocamlary-test-library@f32633993a29a995fa6719c2b4b854bbd5e5f68c.