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

TheoremDoc: Usage of [[mathlib_doc]] not documented #238

Open
JadAbouHawili opened this issue Jun 13, 2024 · 2 comments
Open

TheoremDoc: Usage of [[mathlib_doc]] not documented #238

JadAbouHawili opened this issue Jun 13, 2024 · 2 comments

Comments

@JadAbouHawili
Copy link
Contributor

I was able to discover [[mathlib_doc]] by playing around in my ide and hovering over stuff, but [[mathlib_doc]] is not discussed in the documentation. Any mention of [[mathlib_doc]] is tucked away in server/GameServer/Commands.lean. Shouldn't doc/ discuss it because its hard to notice [[mathlib_doc]] if it isn't mentioned in doc/

@joneugster
Copy link
Collaborator

Oh I thought that was a feature that was never completed/working, but it's certainly on my schedule to do that

@JadAbouHawili
Copy link
Contributor Author

well, for some things it generated the right link but for others it didn't.(but it might be me using it wrong, because it says you need to have the name match whats in mathlib, which is a bit vague)
In any case, I think it should get a mention in doc/ regardless, maybe even stating that its a work in progress. Someone might see this and decide to contribute.

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