[Documentation] Add one markdown file (.md) showing (1) the API of Readline and (2) the API of Reline
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- ruby
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando la directory doc/reline esistente e le API correnti di Readline e Reline. Crea un'unica tabella di confronto in Markdown che includa i metodi importanti, incluso readmultiline, e indica i metodi non portati o che si comportano in modo diverso. Il lavoro è completato quando il file costituisce un riferimento utile e aggiornato per la migrazione parziale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Ruby
- Stelle
- 311
- Fork
- 99
- Merge medio
- 6g 6h
- PR unite (30g)
- 2
Preparare l'ambiente
Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ruby/reline
-
Enabling TruffleRuby on CIAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 68/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
TheOdinProject/curriculum#31423 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
oxidize-rb/rb-sys#807 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno