[2pt] feedback: API reference | Parameters not listed in the prototype
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_rock/vshard/vshard_api/#router-api-buckets-info
SME: @ Gerold103
Details
<…>n: 0
available_rw: 3000
status: 0
alerts: []
...|vshard.router.buckets_info()|
Return information about each bucket. Since a bucket map can be<…>
Parameters are not listed in the prototype (but described below). It is not obvious, whether they're positional or I should pass them like {offset = <...>}.
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 vshard API reference and locate the vshard.router.buckets_info() prototype. Compare its parameter description with the prototype, then clarify the parameters and whether they are positional or passed as a table. Done means the prototype and surrounding documentation agree and the calling convention is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100