Document `message` argument to table constructor of `box.error.new`
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/9102
Product: Tarantool
Since: 3.1
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_error/new/
SME: @ CuriousGeorgiy
Details
Link to the design document
Requested by @ CuriousGeorgiy in https://github.com/tarantool/tarantool/commit/a19aac86b6c94cc13fee5b547ee92afa4a067fa7.
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 root document for box.error.new and review the linked design document and related development issue for the message argument's intended behavior. Update the reference page to document the table constructor's message argument, and consider the work done when that argument is clearly described for Tarantool 3.1.
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
- Mostly clear
- Newbie friendliness
- 55/100