add the ability to link from the docs to the defining file in the source,
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Comienza con scribble/private/manual-proc.rkt y revisa el código del pull request 229, especialmente cómo defproc identifica las definiciones y sus paquetes. Compara la alternativa de identifier-binding con drracket/check-syntax y find-def-in-file. El trabajo estará terminado cuando la documentación generada incluya enlaces al archivo fuente que define cada elemento y, si se incluye el alcance más difícil, a la propia definición.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
it was commented recently that linking to source definitions from the documentation to the defining file in GitHub(lab/etc) would be useful. (note finding the definition of an identifier from DrR or RaMo is already available)
a) defproc code will know the defining file, and the code for the section should know the package that the module is in
alternative: use identifier-binding to get the file (‘Linking to the source file is relatively easy, since that information is in the binding’)
NB see code in https://github.com/racket/scribble/pull/229/files
(harder) to add the ability to link from the docs to the DEFINITION in the defining file in the source,
b) find the line/col with drracket/check-syntax or use find-def-in-file
- Lenguaje dominante
- Racket
- Estrellas
- 251
- Forks
- 101
- Merge medio
- 6 d 22 h
- PR fusionados (30 d)
- 1
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de racket/scribble
-
In source strcut*-doc does not convert to defstruct* properly when #:constructor-name is usedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 74/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de racket/scribble
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
ethereum/execution-specs#3859 ·
Los mantenedores suelen responder en 1 día
-
data:http invalid needs triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
mdn/browser-compat-data#30900 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
2026飞猪AI旅行创新大赛 showcase
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
anthropics/claude-plugins-official#6763 · 10 comentarios · 10 reacciones ·
Los mantenedores suelen responder en 3 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
AFLplusplus/AFLplusplus#2903 ·