[3pt] Add "Possible errors" sections to description of the json module functions
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Add "Possible errors" sections to the description of the json module functions
Product: Tarantool
Since:
Audience/target: developers
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/json/
SME: @romankhabibov
Peer reviewer: @
Details
Need to add description of possible errors for the json module functions. For json.decode(), take into account the changes made in https://github.com/tarantool/tarantool/issues/4339 (in 2.7.1, 2.6.2, and 2.5.3 releases).
Definition of done
-
Possible errorssection is added to the description of the json module functions
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 json module documentation at the linked root document and review issue 4339 for the json.decode() behavior in the specified releases. Add a "Possible errors" section for each json module function, including the version-specific decode details, and verify every function description is covered by the definition of done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100