Feature Request: URL handling in documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- rust
- Área
- compilers, documentation
Línea de trabajo
Comienza en schema/2024-11-05/schema.json#L1061 y sigue cómo se emite esa descripción en target/.../out/schema.rs:3319. Identifica el punto de gestión de URLs en el generador y, después, verifica que la documentación Rust generada envuelva las URLs encontradas entre corchetes angulares y ya no produzca la advertencia sobre URLs sin formato.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Super niche issue, but I ran into this while parsing the MCP schema.
warning: this URL is not a hyperlink
--> .../target/debug/build/mcp-58ca0a9bf43df898/out/schema.rs:3319:1
|
3319 | https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1*/
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: bare URLs are not automatically turned into clickable links
help: use an automatic link instead
|
3319 | <https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1>*/
relevant schema line: https://github.com/modelcontextprotocol/specification/blob/main/schema/2024-11-05/schema.json#L1061
This could end up overly complex if "does this description contain a URL" is harder than one would expect, but it would be nice to wrap urls in <> when encountered to avoid the doc bug and produce better docs.
- Lenguaje dominante
- Rust
- Estrellas
- 898
- Forks
- 114
- Merge medio
- 4 h 18 min
- PR fusionados (30 d)
- 14
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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 oxidecomputer/typify
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
oxidecomputer/typify#1077 · 1 comentario ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
oxidecomputer/typify#1075 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 50/100
oxidecomputer/typify#1060 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 48/100
oxidecomputer/typify#1059 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
oxidecomputer/typify#1022 · 1 comentario ·
Todos los issues de oxidecomputer/typify
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
nautechsystems/nautilus_trader#5095 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
stellar/rs-soroban-env#1739 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
bug good first issue package: quic
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100