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

Hyperlinking missing on some documentation #104

Open
hrmacbeth opened this issue Jan 1, 2023 · 6 comments
Open

Hyperlinking missing on some documentation #104

hrmacbeth opened this issue Jan 1, 2023 · 6 comments

Comments

@hrmacbeth
Copy link

hrmacbeth commented Jan 1, 2023

In the documentation for MulEquiv.withOneCongr, the declaration Equiv.optionCongr is referenced, but there is no automatic hyperlink to that declaration in the docs.

The corresponding documentation in doc-gen3 does have the hyperlink.

The same bug occurs elsewhere, e.g. a missing hyperlink to CanonicallyOrderedCommSemiring in this module docstring, and OrderIso.mulLeft where it misses the link to OrderEmbedding.mulLeft and instead links to a locally-defined mulLeft.

@hrmacbeth
Copy link
Author

hrmacbeth commented Jan 1, 2023

In other examples, a hyperlink is wrongly created. For example, in the module docstring of
https://leanprover-community.github.io/mathlib4_docs/Mathlib/Algebra/GroupPower/Basic.html
the word pow gets a hyperlink, seemingly at random, to Dvd.dvd.pow. The same bug occurs in other module docstrings.

The corresponding documentation in doc-gen3 does not have that hyperlink.

@hargoniX
Copy link
Collaborator

This is due to our hyperlinking heuristic. Ideally I would hope we could at some point end up with a standartized version of Lean markdown that has a standartized implementation.

@alreadydone
Copy link

alreadydone commented Sep 20, 2023

I came here to file an issue because I observed the reference to minpoly.equivAdjoin at AdjoinRoot.Minpoly.toAdjoin doesn't render as a link, only to discover this has already been reported 8 months ago.

@ericrbg
Copy link

ericrbg commented Dec 6, 2023

Another one is Nat.toFinset_factors

@fpvandoorn
Copy link

Another one: WfDvdMonoidWfDvdMonoid not hyperlinking DvdNotUnit

@acmepjz
Copy link
Contributor

acmepjz commented Jul 4, 2024

I came here to file an issue because I observed the reference to minpoly.equivAdjoin at AdjoinRoot.Minpoly.toAdjoin doesn't render as a link, only to discover this has already been reported 8 months ago.

I think it's because that minpoly.equivAdjoin is a downstream definition.

Another one is Nat.toFinset_factors

Another one: WfDvdMonoidWfDvdMonoid not hyperlinking DvdNotUnit

These two are not related to the auto-linking of codes in markdown. That must be some other unimplemented things.

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

6 participants