Update the description of the methods and parameters in the net.box
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):
Product: Tarantool
Since: 2.10.0-beta1
Root document: https://www.tarantool.io/en/doc/latest/contributing/docs/examples/#parameters-in-functions-and-classes
SME: @ alyapunov
Details
Update the description of the methods and parameters in the net.box according to the guideline: https://www.tarantool.io/en/doc/latest/contributing/docs/examples/#parameters-in-functions-and-classes
Definition of done
- The description of methods and parameters in net.box has been updated according to the guideline.
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 linked parameter guideline and the net.box documentation entry points mentioned in the issue. Locate the method and parameter descriptions, compare them with the guideline, and update all affected documentation; done means the net.box descriptions follow the guideline.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100