hide redundant fields of box.error.unpack()
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/tarantool/issues/9101
Product: Tarantool
Since: 3.1
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/compat/
SME: @ nshy
Details
Do not show redundant fields of box.error.unpack(). These are base_type,
custom_type and code if the latter is 0.
New behaviour is available if box_error_unpack_type_and_code compat
option is 'new'. Default value is 'old` currently.
Requested by @ nshy in https://github.com/tarantool/tarantool/commit/ee08747291788868ddd5fe5f0571b48c2501b89b.
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 the compat reference linked as the root document and locate the box.error.unpack() description. Check how base_type, custom_type, and code are documented for the box_error_unpack_type_and_code option, then update the documentation to reflect the new behavior. Done means the redundant fields and the code=0 case are no longer presented as output when the option is set to 'new'.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100