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

odoc cannot handle alerts for type aliases #1230

Open
favonia opened this issue Oct 31, 2024 · 1 comment
Open

odoc cannot handle alerts for type aliases #1230

favonia opened this issue Oct 31, 2024 · 1 comment

Comments

@favonia
Copy link
Contributor

favonia commented Oct 31, 2024

odoc seems to have trouble handling deprecation alerts attached to type aliases, for example this one:

type int2 = int [@@ocaml.alert deprecated "Just use int"]

Here's odoc's complaint:

File "src/Test.mli", line 1, characters 16-57:
Warning: Alert deprecated not expected here.

However, the OCaml compiler seems to accept and handle such an alert perfectly.

@favonia favonia changed the title Alerts for type aliases Odoc cannot handle alerts for type aliases Nov 1, 2024
@favonia favonia changed the title Odoc cannot handle alerts for type aliases odoc cannot handle alerts for type aliases Nov 1, 2024
@jonludlam
Copy link
Member

Thanks for reporting this! It does indeed look like our issue. I'll take a look and see what's required to fix this.

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

2 participants