Skip to content
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.

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

Fiddle 3.0を新設 #2810

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fiddle 3.0を新設 #2810

wants to merge 1 commit into from

Conversation

kojix2
Copy link
Contributor

@kojix2 kojix2 commented May 19, 2023

Fiddleのドキュメントが古くなっており、現在のFiddleとは異なる部分が多いように感じます。

たとえば、library fiddle/importのページを見ると、

image

という記述がありますが、現在ではネストされた構造体はサポートされています。参照: FiddleのREADME

ドキュメントを改善する必要性を感じました。

しかし、現在のドキュメントは、kouさんがメンテナンスを引き継ぐ前の古いFiddle(特にRuby 2.6ぐらいまでのバージョン)に関する情報としては適切なものであり、直接編集することは躊躇されました。そのため、新しく3.0のディレクトリを作成することが適切だと考えました。

したがって、新たに3.0というディレクトリを作成しました。これは、単純に2.0のディレクトリをコピーしただけのものです。
よろしくおねがいします。

@kojix2
Copy link
Contributor Author

kojix2 commented May 31, 2023

このままだとマージできないため修正した方がよい点はありますか?

@znz
Copy link
Member

znz commented May 31, 2023

既存のファイルの中にバージョン分岐で追加していくのは大変そうでしょうか?
大変だから完全に別ファイルにしたいということなら、 https://github.com/rurema/doctree/blob/7ed3cc455b082e853d86d13bf210182a31fa9604/refm/api/src/fiddle.rd のように起点となるファイルを include しているところで分岐して、古いバージョン向けの記述はばっさり削ってしまって良いと思います。
(完全に別ファイルにするなら refm/api/src/fiddle/import.rdrefm/api/src/fiddle/types.rd もバージョン分岐にする必要があると思います。)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants