Link to a complete source from doc popups
- Lenguaje dominante
- Haskell
- Estrellas
- 1.3k
- Forks
- 201
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.)
Guía de contribución
Línea de trabajo
Empieza por rastrear la ventana de documentación que utilizan autocomplete y doc-on-hover. Lee cómo los símbolos integrados exponen la documentación Haddock generada y cómo los símbolos definidos en el código permiten la navegación; inspecciona el formato de anclaje de Haddock y el comportamiento de la ventana emergente. Se considera terminado cuando la ventana emergente proporciona un enlace utilizable a la documentación completa o a la definición, y doc-on-hover sigue siendo interactivo.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- haskell
- Área
- developer-experience, documentation, frontend
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 30/100