Skip to content

Issues: picoruby/picoruby.github.io

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

15 Open 0 Closed
15 Open 0 Closed
Author
Filter by author
Loading
Label
Filter by label
Loading
Use alt + click/return to exclude labels
or ⇧ + click/return for logical OR
Projects
Filter by project
Loading
Milestones
Filter by milestone
Loading
Assignee
Filter by who’s assigned
Sort
Sort by
Newest Oldest Most commented Least commented Recently updated Least recently updated Best match
Most reactions
👍 👎 😄 🎉 😕 ❤️ 🚀 👀

Issues list

mruby/cがmodule機能を（限定的に）実装したのでドキュメントの仕組みもmoduleに対応しなきゃならない！
#19 opened Aug 28, 2024 by hasumikin
ドキュメント内の静的コンテンツとして関連記事へのリンクとかコラムを新たに書くとかもやっていけたらよさそう
#16 opened Mar 10, 2024 by hasumikin
この自動生成の仕組みに汎用性を持たせてgem化する。jekyll pluginでもよいかも。このためにはPicoRubyには（いまのところは）ないmoduleにも対応する必要がある。PicoRubyにもmodule機能が入るかもしれないので、やっておくとよさそうではある
#15 opened Mar 10, 2024 by hasumikin
RBSにはオプショナル引数のデフォルト値の情報が含まれない。たとえばrbファイルではdef m(a=0)となっている場合に、rgsではdef m: (?Integer a)となっていて、aのデフォルト値が0であることがわからない。デフォルト値をドキュメント化したいので、いいやり方がないか考えたい（コメントに書くとかでもいい思うが、rb実装との二重管理になってしまうから、rb実装ファイルから自動的に持ってこられるとありがたい）
#14 opened Mar 10, 2024 by hasumikin
GitHub Action：picoruby/picoruby（masterブランチ）へのプッシュ時にrbsファイルが変更されていたらpicoruby/picoruby.github.ioを自動で更新するようにしたい
#13 opened Mar 10, 2024 by hasumikin
privateメソッドは現状ドキュメンテーションに含めていないが、privateセクションを設けて載せるようにしてもいいかもしれない。ただし@ignoreが注釈されていたら載せない
#12 opened Mar 10, 2024 by hasumikin
定数もドキュメント化したい
#11 opened Mar 10, 2024 by hasumikin
いまは（画像参照）member[:souce]（(Integer) -> 0みたいな素のテキスト）を生成ドキュメントにそのまんま使用しているが、member[:required_positionals]以下の情報（現在は未使用）を組み合わせてドキュメントを生成するようにしたい。これができると、たとえばIntegerという型名からInteger.htmlへリンクできるのではないかと思っている。type_aliasも同様にリンクしたい
#10 opened Mar 10, 2024 by hasumikin
継承（superクラス）についての情報を載せたい
#9 opened Mar 10, 2024 by hasumikin
あわせて、picoruby/mrbgems/picoruby-mrubyc/sig/*.rbs（つまりPicoRubyコアライブラリの型情報）の多くは、rbs gemがもっているCRubyコアの型ファイルをコピってきてsteep checkが通るだけの状態へ雑に編集しただけのもの。パクってきたときにいっしょについてきた元々のコメントには解説文（riで読めるやつ）がくっついているので、これの記法も整合性をとる必要あり
#8 opened Mar 10, 2024 by hasumikin
rbsファイル内のclass定義やメソッド定義にマークダウン（？）でコメント（用例など）を書くと、それがドキュメントにも載るようにしたい。注意点としては、すでにコメント部分には機能があって、@sidebar @added_by @ignoreという注釈がmd生成に影響を与えているので、そことの整合性を設計する必要あり
#7 opened Mar 10, 2024 by hasumikin
tagsの機能がうまく動いていない（たとえば https://picoruby.github.io/tag_introduction.html が404）
#6 opened Mar 10, 2024 by hasumikin
picoruby/mrbgems/picoruby-mrubyc/sig/*.rbsは、rbs gemがもっているCRubyコアの型ファイルからパクってきてsteep checkが通るだけの状態へ雑に編集しただけのもの。不正確な情報（とくにオーバーロードの型情報やコメント部に書かれた文書。mrubycは同じメソッド名でも機能が限定されていることが多い）が含まれているので、これを直していきたい
#5 opened Mar 10, 2024 by hasumikin
rbsのメソッド定義に引数名をなるべく書き足す。たとえば、現状def m: (Integer)となっているなら、def m: (Integer a)のように引数の変数名を書き加えたい（rbファイルのほうにdef m(a);...;endのように書いてあるから、それを見て補う）。変数名が不適切だったら、ついでに直しちゃってもよい
#4 opened Mar 10, 2024 by hasumikin
ROAD MAP
#1 opened Jan 24, 2024 by hasumikin
13 tasks
ProTip! Updated in the last three days: updated:>2024-11-14.