[DOC] Undocumented entries in IRB.conf
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Ruby
- Stars
- 478
- Forks
- 158
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 12
Description
The recent revision of the main IRB documentation has three :stopdoc:/:startdoc: directive pairs that try to mention but omit several undocumented entries in IRB.conf:
- IRB.conf[:LC_MESSAGES]
- IRB.conf[:MEASURE] IRB.conf[:MEASURE_CALLBACKS] IRB.conf[:MEASURE_PROC]
- IRB.conf[:CONTEXT_MODE]
The directives did not work, however, so the mentions have leaked into the finished html doc,
I'll be removing those from the main doc, and so am mentioning them here to prevent loss.
Contributor guide
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 with the main IRB documentation and inspect how the :stopdoc:/:startdoc: directive pairs handle IRB.conf entries. Confirm where the listed entries should be mentioned and verify that they are not leaked into the finished HTML documentation; the issue does not name a specific file or test.
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