[DOCS] Incorrect documentation for binary formatter
Open
Nobody has claimed this yet.
bug?
- Dominant language
- Ruby
- Stars
- 10k
- Forks
- 1.2k
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 92
Description
The documentation states that to pass objects through "as is" to specify the :binary formatter.
It appears there is no :binary formatter, rather that a nil formatter should be specified to instruct Grape to pass objects through "as is". Should the documentation be updated?
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 locating the documentation section that describes passing objects through "as is" with the :binary formatter, then compare it with the issue's reported behavior. Update the documentation to refer to a nil formatter, and consider the work done when it no longer claims that :binary provides this 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
- 30/100