[Config] Update the box API reference's descriptions to using a new config
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Epic: https://github.com/tarantool/doc/issues/3544
Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box/
SME: @ Totktonada
Details
Example API members:
box.ctl.on_schema_init()
box.info
box.info.listen
box.info.replication
box.info.synchro
box.schema.space.create()
box.session.on_auth()
box.session.type()
System space views
It is necessary to check other API members as well.
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 box API root document and compare the listed members—box.ctl.on_schema_init(), box.info, box.schema.space.create(), box.session APIs, and system space views—against the new configuration described by epic #3544. Review the other API members as well; done means the affected descriptions consistently document the new configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100