ROAD MAP

[hasumikin]

機能開発

• rbsファイル内のclass定義やメソッド定義にマークダウン（？）でコメント（用例など）を書くと、それがドキュメントにも載るようにしたい。注意点としては、すでにコメント部分には機能があって、@sidebar @added_by @ignoreという注釈がmd生成に影響を与えているので、そことの整合性を設計する必要あり #7
• あわせて、picoruby/mrbgems/picoruby-mrubyc/sig/*.rbs（つまりPicoRubyコアライブラリの型情報）の多くは、rbs gemがもっているCRubyコアの型ファイルをコピってきてsteep checkが通るだけの状態へ雑に編集しただけのもの。パクってきたときにいっしょについてきた元々のコメントには解説文（riで読めるやつ）がくっついているので、これの記法も整合性をとる必要あり #8
• 継承（superクラス）についての情報を載せたい #9
• いまは（画像参照）member[:souce]（(Integer) -> 0みたいな素のテキスト）を生成ドキュメントにそのまんま使用しているが、member[:required_positionals]以下の情報（現在は未使用）を組み合わせてドキュメントを生成するようにしたい。これができると、たとえばIntegerという型名からInteger.htmlへリンクできるのではないかと思っている。type_aliasも同様にリンクしたい #10
• 定数もドキュメント化したい #11
• privateメソッドは現状ドキュメンテーションに含めていないが、privateセクションを設けて載せるようにしてもいいかもしれない。ただし@ignoreが注釈されていたら載せない #12
• GitHub Action：picoruby/picoruby（masterブランチ）へのプッシュ時にrbsファイルが変更されていたらpicoruby/picoruby.github.ioを自動で更新するようにしたい #13

Jekyll関連の問題

• tagsの機能がうまく動いていない（たとえば https://picoruby.github.io/tag_introduction.html が404） #6

比較的単純（？）な作業

• rbsのメソッド定義に引数名をなるべく書き足す。たとえば、現状def m: (Integer)となっているなら、def m: (Integer a)のように引数の変数名を書き加えたい（rbファイルのほうにdef m(a);...;endのように書いてあるから、それを見て補う）。変数名が不適切だったら、ついでに直しちゃってもよい #4
• picoruby/mrbgems/picoruby-mrubyc/sig/*.rbsは、rbs gemがもっているCRubyコアの型ファイルからパクってきてsteep checkが通るだけの状態へ雑に編集しただけのもの。不正確な情報（とくにオーバーロードの型情報やコメント部に書かれた文書。mrubycは同じメソッド名でも機能が限定されていることが多い）が含まれているので、これを直していきたい #5

検討したいこと

• RBSにはオプショナル引数のデフォルト値の情報が含まれない。たとえばrbファイルではdef m(a=0)となっている場合に、rgsではdef m: (?Integer a)となっていて、aのデフォルト値が0であることがわからない。デフォルト値をドキュメント化したいので、いいやり方がないか考えたい（コメントに書くとかでもいい思うが、rb実装との二重管理になってしまうから、rb実装ファイルから自動的に持ってこられるとありがたい） #14

将来そのうちやりたいかも

• この自動生成の仕組みに汎用性を持たせてgem化する。jekyll pluginでもよいかも。このためにはPicoRubyには（いまのところは）ないmoduleにも対応する必要がある。PicoRubyにもmodule機能が入るかもしれないので、やっておくとよさそうではある #15
• ドキュメント内の静的コンテンツとして関連記事へのリンクとかコラムを新たに書くとかもやっていけたらよさそう #16