Skip to content

v0.16.4のドキュメントレビュー #1289

@Hiroshiba

Description

@Hiroshiba

内容

タイトルの通りです。

のレビューをメモしていきます!

レビュー

チェックボックス形式にしてみました。
(たぶん @qryxip さん側でもチェックボックスの更新ができるはず・・・?)

  • usage.mdにソングへのリンクがなさそう
    • 別に良いけど導線が減ってもったいないかも
    • あるいはもしかしたらまだリンクしない方針だったかも・・・?
  • ソング系APIだけ例が豊富に書かれていて不揃いがありそう
    • これたしかどういう方針でやっていこうみたいなのが決まった気がするけどdocument内に書かれてなさそう?
    • どういう方針なのか(ソングが例外?トークの例が少ない?など)をドキュメント内に書くか、issueを作れば解決そう
    • APIドキュメントにコード例を書く #563
  • もうちょっとソング周りのドキュメントをわかりやすくする、という主旨のissueを作ると良さそう
  • (ちょっとドキュメントと関係ないけど)追加予定の関数をissue化しておいても良いかも
  • create_sing_frame_audio_queryのドキュメントの「楽譜」のとこからScoreへジャンプできなかった
    • ここ
    • 別に致命的ではないのでissue作って0.16.4リリースでも全然問題なさそう

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions