Use `///` for all docs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 48/100
Línea de trabajo
Empieza siguiendo cómo prettyplease da formato a los atributos de documentación de Rust, usando los ejemplos de una sola línea y de varias líneas del issue como salida esperada. Comprueba las pruebas o fixtures existentes del formatter para la salida de documentación y añade cobertura que muestre que cada línea usa ///; después, verifica el resultado formateado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Hi! Is there any reason why multi-line docs are formatted using /**?
For example, the following code:
#[doc = " This is a single line doc"]
pub type foo = ::std::os::raw::c_int;
#[doc = " This is a multi line doc.\n With way too many lines"]
pub type bar = ::std::os::raw::c_int;
is being formatted as
/// This is a single line doc
pub type foo = ::std::os::raw::c_int;
/** This is a multi line doc.
With way too many lines*/
pub type bar = ::std::os::raw::c_int;
and I'd like it to be
/// This is a single line doc
pub type foo = ::std::os::raw::c_int;
/// This is a multi line doc.
/// With way too many lines
pub type bar = ::std::os::raw::c_int;
- Lenguaje dominante
- Rust
- Estrellas
- 775
- Forks
- 49
- Métricas de merge de PR
- Sin PR fusionados en 30 d
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 dtolnay/prettyplease
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
dtolnay/prettyplease#127 ·
-
What does cargo:VERSION do?Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
dtolnay/prettyplease#125 · 4 comentarios ·
-
Better macros 2.0 formattingAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
dtolnay/prettyplease#111 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
dtolnay/prettyplease#62 · 1 comentario ·
-
`quote`-compatible exampleAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
dtolnay/prettyplease#61 · 2 comentarios · 13 reacciones ·
Todos los issues de dtolnay/prettyplease
Issues similares
-
priority: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
storytold/photocraft#15350 ·
Los mantenedores suelen responder en 1 día
-
area:davinci
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
ubugeeei-prod/vize#13167 ·
Los mantenedores suelen responder en 1 día
-
area:ui enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
transit-audio/transit#738 ·
Los mantenedores suelen responder en 1 día
-
enhancement good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 91/100
hocinehacherouf/liberarr#78 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día