Documentation of Reline #598
Description
ref #552 (comment)
Our team has been working on quite a lot of development, to the point where we need to start writing some documents.
Where to doc?
candidates:
- README.md
Simplest way. As the number of descriptions increases, the file may become harder to read - doc/reline/*md
like https://github.com/ruby/csv/tree/master/doc/csv
I prefer the latter.
What to doc?
- Reline.autocompletion
- Reline.dig_perfect_match_proc
- Reline.output_modifier_proc
- Reline.completion_proc
- Reline::Face
any other things?
How to doc?
- Markdown --- I think everyone will agree
Activity
st0012 commentedon Nov 4, 2023
My opinion: document in README directly first, and then create more specific
doc/[topic].mdfiles later if needed.tompng commentedon Nov 4, 2023
I think important thing can be written in README.
How to customize color can be also in IRB, with simple description and a link to Reline's document.
refs ruby#598
Introduce a new class Reline::Face to configure character attributes (#…
[ruby/reline] Introduce a new class Reline::Face to configure