json doc page needs to be updated
Open
Nobody has claimed this yet.
add details
reference
server
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Since: 1.10
Audience/target: anyone using json builtin module
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/json/
SME: @igormunkin, @Totktonada
Details
- There is not a single word regarding
json.newinterface. json.NULLdescription looks a bit odd to me.
Definition of done
- Describe json.new
- Clarify json.NULL description
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 linked JSON builtin module reference page and review the existing json.NULL description and surrounding interface documentation. Add the missing json.new description and clarify json.NULL, then verify both Definition of done items are satisfied on the rendered page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100