ruby-grape / ruby-grape/grape-entity
Missing Documentation for :with option in expose
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 729
- Forks
- 154
- PR merge metrics
- No merged PRs in 30d
Description
The inline documentation of expose (https://github.com/intridea/grape-entity/blob/master/lib/grape_entity/entity.rb#L126) documents the different options available to be passed to expose. The :with option is missing in this documentation to expose embedded arrays.
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
Open lib/grape_entity/entity.rb around line 126 and read the inline documentation for expose and its existing options. Document the :with option for exposing embedded arrays, matching the surrounding style. Done means the inline documentation explains this option clearly without changing behavior.
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
- 55/100