ruby / ruby/reline

[Documentation] Add one markdown file (.md) showing (1) the API of Readline and (2) the API of Reline

Open
#772 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
311
Forks
99
Avg merge
6d 4h
Merged PRs (30d)
1

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing doc/reline directory and the current Readline and Reline APIs. Create one Markdown comparison table covering the important methods, including readmultiline, and note methods that are unported or behave differently. Done means the file is an up-to-date, useful partial migration reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.