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

Documentation: don't refer to functoria documentation #1512

Open
reynir opened this issue Mar 24, 2024 · 1 comment
Open

Documentation: don't refer to functoria documentation #1512

reynir opened this issue Mar 24, 2024 · 1 comment

Comments

@reynir
Copy link
Member

reynir commented Mar 24, 2024

From time to time I look up documentation using either Merlin or ocp-browser, and a few values such as Mirage.package says e.g. "Same as Functoria.Package.v". This is rather annoying as in both Merlin and ocp-indent there are no hyperlinks to get to the actual documentation.

Another one is Mirage.impl that defines itself as of_device @@ Device.v where Mirage doesn't even have a Device module.

Somewhat motivated by mirage/mirage-skeleton#388.

@samoht
Copy link
Member

samoht commented Mar 24, 2024

Yea, that's a very good point. I'm trying to fix those when I see those references, but it would be nice to have a more systematic review of those references.

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