Document deep_interpolation in RDoc
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1k
- Forks
- 415
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 1
Description
The option is documented, in the Rails guide (https://guides.rubyonrails.org/i18n.html#bulk-and-namespace-lookup). I'd like to suggest additionally documenting it in the RDoc for translate (https://rubydoc.info/github/ruby-i18n/i18n/I18n%2FBase:translate), since that also seems intended to function as a sort of brief how-to and already mentions interpolation. This isn't some massive improvement, obviously, but it would have saved me 10 minutes of searching.
Since this is my first issue, I'd like to also say: thank you for maintaining this gem :)
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
Locate the RDoc for I18n::Base.translate and compare it with the Rails guide section linked in the issue. Document the deep_interpolation option alongside the existing interpolation guidance; done means the translate RDoc explains how the option works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100