google / google/codeworld

Link to a complete source from doc popups

Offen
#816 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
Haskell
Sterne
1.3k
Forks
201
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

The doc window in autocomplete and doc-on-hover has the first part of the documentation for a symbol, but it's often cut off. Ideally, it would contain a link to the full documentation. For built-in symbols, this link could open the guide to the generated haddock for the symbol (this requires understanding haddock's anchor format...). For symbols defined in the code, it could act like a go-to-definition feature.

(For doc-on-hover, this implies making a change so that it's possible to click on the doc window at all. The obvious candidate here is to make the doc location "stickier", so that once it opens, it remains in the same place even when the mouse moves, so long as the mouse is over the same symbol, or is hovering over the doc window.)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, das Dokumentationsfenster nachzuverfolgen, das von autocomplete und doc-on-hover verwendet wird. Lies nach, wie integrierte Symbole generierte Haddock-Dokumentation bereitstellen und wie im Code definierte Symbole die Navigation unterstützen; untersuche das Ankerformat von Haddock und das Verhalten des Hover-Fensters. Als erledigt gilt die Arbeit, wenn das Popup einen nutzbaren Link zur vollständigen Dokumentation oder zur Definition bereitstellt und doc-on-hover weiterhin anklickbar bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
haskell
Bereich
developer-experience, documentation, frontend
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.