typesetting of header / yaml

Abierto
#55 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
r

Línea de trabajo

Start with the linked AuthoringRmdVignettes.html vignette and inspect how BiocStyle renders its YAML/header section in Safari and Chrome on OS X. Compare the indentation, package newline, compilation-date label, and last-edited-date behavior with the requested formatting; done means the agreed header layout is demonstrated consistently in the package vignette.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

On both Safari and Chrome on OS X I see the top of the following vignette rendered with weird indentation: http://bioconductor.org/packages/devel/bioc/vignettes/BiocStyle/inst/doc/AuthoringRmdVignettes.html

I see

  • author names and affiliation are indented
  • date (add automatically, see below) indented
  • the work abstract note indented, newline and then no indentation of the abstract text.
  • similar with Package

I think all bold headers should have the same indentation level, and personally I think they should be non-indented.

I think it is weird that there is a newline after package. I would prefer no newline after the yaml stuff.

I think the auto-adding of the compilation time date is "bad" as we have seen from experience. I propose that at a minimum it gets prefaced with "Compilation date:" and I also think we should have the capability (and demonstrated in the package vignette) to have an "Last edited date:". Experience have shown this to be very useful.

Lenguaje dominante
R
Estrellas
15
Forks
20
Merge medio
1 d 17 h
PR fusionados (30 d)
14

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 Bioconductor/BiocStyle

Todos los issues de Bioconductor/BiocStyle

Issues similares

Más issues de R

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.