Error formatter new argument change not documented
Open
Nobody has claimed this yet.
bug?
- Dominant language
- Ruby
- Stars
- 10k
- Forks
- 1.2k
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 92
Description
Custom error formatter must have now 5 arguments instead of the old 4. These changes were introduced here on #1652
When migrating from 0.19 to 1.1.0 I had issues on a custom error formatter because the original_exception argument was introduced but that change was not documented on the upgrading guide.
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 with the upgrading guide and compare its custom error formatter migration notes with change #1652. Document that the formatter now receives five arguments, including original_exception, and verify that the 0.19-to-1.1.0 migration guidance reflects the change.
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