Comment indentation creates failing doctests
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 55/100
Línea de trabajo
Start by reproducing the failure with the Rust doc attribute shown in the issue and the documented .clang_arg options. Read the bindgen code that handles C comments and generates Rust documentation to find where indentation becomes a failing doctest. Done means the generated documentation no longer creates a failing doctest for the example; the issue leaves the implementation approach open.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
cargo test fails if the code for which bindings are generated inadvertently contains indented markdown code blocks.
For instance, if this is generated in a library:
#[doc = "This fails\n\n to compile"]
a doctest is created that fails to compile.
Could this be avoided somehow? For instance, could I disable interpreting C comments as markdown when using
.clang_arg("-fretain-comments-from-system-headers")
.clang_arg("-fparse-all-comments")
E.g. using raw string
#[doc = r#"This does not fail\n\n to compile"#]
does not seem to create a doctest.
- Lenguaje dominante
- Rust
- Estrellas
- 5.3k
- Forks
- 846
- Merge medio
- 2 d 6 h
- PR fusionados (30 d)
- 11
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
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 rust-lang/rust-bindgen
-
--enable-cxx-namespaces panics on namespace [[deprecated]] { ("[" is not a valid Ident)Posiblemente ocupada @lwz23 la tomó hace 48 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
rust-lang/rust-bindgen#3485 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
rust-lang/rust-bindgen#3483 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
rust-lang/rust-bindgen#3370 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
rust-lang/rust-bindgen#3363 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
rust-lang/rust-bindgen#3540 ·
Los mantenedores suelen responder en 1 día
Todos los issues de rust-lang/rust-bindgen
Issues similares
-
area: cli kind:docs priority: P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
swc-project/swc-ai-issues#164 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
pop-os/cosmic-player#367 ·
-
good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
servo/rust-smallvec#873 ·