doc-gen4 icon indicating copy to clipboard operation
doc-gen4 copied to clipboard

Hyperlinking missing on some documentation

Open hrmacbeth opened this issue 2 years ago • 6 comments

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 avatar Jan 01 '23 17:01 hrmacbeth

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.

hrmacbeth avatar Jan 01 '23 17:01 hrmacbeth

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.

hargoniX avatar Jan 22 '23 12:01 hargoniX

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.

alreadydone avatar Sep 20 '23 15:09 alreadydone

Another one is Nat.toFinset_factors

ericrbg avatar Dec 06 '23 12:12 ericrbg

Another one: WfDvdMonoidWfDvdMonoid not hyperlinking DvdNotUnit

fpvandoorn avatar May 14 '24 12:05 fpvandoorn

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.

acmepjz avatar Jul 04 '24 19:07 acmepjz