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

Don't resolve references between stop comments #818

Open
Julow opened this issue Feb 4, 2022 · 1 comment
Open

Don't resolve references between stop comments #818

Julow opened this issue Feb 4, 2022 · 1 comment

Comments

@Julow
Copy link
Collaborator

Julow commented Feb 4, 2022

In this example, the comment containing the reference and the target of the reference are "removed" from the documentation with stop comments:

(** . *)

(**/**)

val x : int

(** {!x} *)

(**/**)

Odoc attempts to resolve the reference but fails, which result in unfixable warnings.

@Julow
Copy link
Collaborator Author

Julow commented Jul 11, 2024

This no longer result in a warning since recent changes to hidden paths.
References are still being resolved:

(** . *)

(** {!x} *)

(**/**)

val x : int

(** {!y} *)

(**/**)

The reference {!x} resolves, and result in an anchor to #val-x which is wrong. Reference {!y} results in an error.

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

2 participants