typesetting of header / yaml

オープン
#55 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR(30日)
14

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Bioconductor/BiocStyle のほかの issue

Bioconductor/BiocStyle の issue をすべて見る

似ている issue

R の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。