ruby / ruby/irb

Add documentation of the default values of IRB.conf

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

Nobody has claimed this yet.

documentation
Dominant language
Ruby
Stars
478
Forks
158
Avg merge
1d 12h
Merged PRs (30d)
12

Description

When searching the internet have not ever been able to find a page that state the default values for the IRB.conf which is usually referenced in ~/.irbrc

I (again) realized that you can use puts IRB.conf however it would be nice to have the output of this within the Ruby docs. This way when searching online you will end up finding the info you are looking for.

Contributor guide

Open the contributing guide

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 examining the existing Ruby documentation around IRB.conf and the ~/.irbrc configuration context, then run puts IRB.conf to compare the documented values with the current defaults. The work is done when the Ruby docs clearly list the default IRB.conf values that users need when configuring ~/.irbrc.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.