[3pt] feedback: API reference | Example doesn't match the description
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
<…>t bucket to show
limit – the maximum number of buckets to show|Return:a map of the following type: {bucket_id = 'unknown'/replicaset_uuid}|
COPYvshard.router.buckets_info()tarantool> vshard.router.bucke<…>
I don't know how to match this description with the example just below. They look just different. Please, clarify.
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 vshard router API reference and inspect the router-api-buckets-info section for vshard.router.buckets_info(). Compare the return description with the example immediately below it; done means the example and description clearly describe the same API behavior.
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
- 45/100