[Documentation] Could a standalone example be added for working with tab-completion?
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 311
- Forks
- 99
- Avg merge
- 6d 4h
- Merged PRs (30d)
- 1
Description
Hey there,
Could a standalone example be added to showcase how to use reline with regards
to tab completion? For instance in a REPL:
cd /home/fo<PRESS_TAB_HERE>
I can probably look at readline, but I think it would be better to have the documentation
within the reline project itself here. Finding documentation in ruby is getting increasingly
difficult; I can barely find anything anymore with google search and there also does not
seem to be a plethora of discussions about ruby anymore. We seem to lose documentation
rapidly right now (excluding Burdette Lamar who is doing a heroic job to counter this).
This loss of easy as-is documentation for ruby-project should be countered in general.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the reline project documentation and the existing tab-completion or REPL examples, using readline as a reference if needed. Add a standalone example that demonstrates completing a path such as /home/fo; the documentation is done when a reader can follow it to try tab completion themselves.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100