Document increased error serialization verbosity
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/9105
Product: Tarantool
Since: 3.1
Root document:
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_error/
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_error/error
- https://tarantool.io/compat/box_error_serialize_verbose
SME: @ CuriousGeorgiy
Details
Please add a new https://tarantool.io/compat/box_error_serialize_verbose
page for the box_error_serialize_verbose compatibility option.
Requested by @ CuriousGeorgiy in https://github.com/tarantool/tarantool/commit/cc7af2ebc21295a19392e3291d8212d3eef6b087.
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 existing box_error and box_error/error reference pages, then review the compatibility documentation linked in the issue and the referenced design document. Add the box_error_serialize_verbose compatibility page with the option's documented behavior and links to the relevant error documentation; done means the new page is available at the requested compatibility URL.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100