Use `///` for all docs

Abierto
#44 4 comentarios 7 reacciones 0 asignados Ver en GitHub

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
tooling

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

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de dtolnay/prettyplease

Todos los issues de dtolnay/prettyplease

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.