[Documentation] Add one markdown file (.md) showing (1) the API of Readline and (2) the API of Reline
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
調査の方向性
まず既存の doc/reline ディレクトリと現在の Readline および Reline API を確認します。readmultiline を含む重要なメソッドを網羅した 1 つの Markdown 比較表を作成し、未移植のメソッドや動作が異なるメソッドを記載します。ファイルが最新で有用な部分移行リファレンスになっていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Would it be possible to add one .md markdown file,
that is like a table layout?
On the left side, there should be the old Readline API.
On the right side, there should be the new Reline API.
Ideally both should be up-to-date.
This file could be put under https://github.com/ruby/reline/tree/master/doc
or doc/reline there. The name could be "API-table" or "API_comparison_table.md"
or something like that.
It does not have to be complete; it can be kept as a partial helper, just showing
the more important API changes (if any).
For instance:
Reline.readmultiline
Specifically, that .md file could also include some helpful advice, and also notices
which methods haven't been ported yet, or which may behave differently.
At any rate, thanks for reading this issue request. I am currently porting some
old Readline code, over to Reline, and the documentation can ideally be improved
for Reline, so that we poor souls can all abandon Readline eventually.
- 主要言語
- Ruby
- スター
- 311
- フォーク
- 99
- 平均マージ
- 6日 6時間
- マージ済み PR（30日）
- 2
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ruby/reline のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
似ている issue
-
security
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
ds-drift
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
we-promise/sure#3934 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 7 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
simp/pupmod-simp-ssh#246 ·