typesetting of header / yaml

未关闭
#55 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
r
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
R
星标
15
派生
20
平均合并
1 天 17 小时
30 天内合并 PR
14

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Bioconductor/BiocStyle 的其他 Issue

查看 Bioconductor/BiocStyle 的全部 Issue

相似的 Issue

更多 R Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。