ruby-grape / ruby-grape/grape-entity
Why docs suggest strings for root option?
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 729
- Forks
- 154
- PR merge metrics
- No merged PRs in 30d
Description
So why root 'users', 'user' not root :users, :user when all expose methods in docs generates symbols i.e. expose :user_name
I find it out when using merge: true option and comparing keys.
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 by reviewing the documentation for the root option and the expose examples, then compare the documented string and symbol forms when using merge: true. Done means the documentation clearly explains the expected form and its relationship to the observed key comparison, or records the reason for keeping the current examples.
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
- 38/100