Skip to content

[3pt] feedback: API reference | Example doesn't match the description #2369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tracked by #2640
TarantoolBot opened this issue Oct 13, 2021 · 1 comment
Open
Tracked by #2640
Labels
add details [nature] More details needed, some info missing. Documentation is incomplete. ecosystem [area] Task relates to Tarantool's ecosystem (connector, module, other non-server functionality) example Problem with a code example. vshard [area] Related to vshard module

Comments

@TarantoolBot
Copy link
Collaborator

TarantoolBot commented Oct 13, 2021

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.

@Totktonada
Copy link
Member

#2370 shed some light on this, but {[bucket_id] = <...>} should be used instead of {bucket_id = <...>} (if you want to use Lua syntax). However 'unknown'/replicaset_uuid still does not match {uuid = <...>, status = <...>} maps in the example.

@Totktonada Totktonada added the vshard [area] Related to vshard module label Oct 13, 2021
@veod32 veod32 added ecosystem [area] Task relates to Tarantool's ecosystem (connector, module, other non-server functionality) add details [nature] More details needed, some info missing. Documentation is incomplete. labels Oct 22, 2021
@veod32 veod32 changed the title feedback: API reference | Tarantool [3pt] feedback: API reference | Tarantool Oct 22, 2021
@veod32 veod32 added this to the vshard doc issues milestone Oct 22, 2021
@patiencedaur patiencedaur mentioned this issue Feb 1, 2022
21 tasks
@patiencedaur patiencedaur removed this from the vshard milestone Feb 1, 2022
@patiencedaur patiencedaur changed the title [3pt] feedback: API reference | Tarantool [3pt] feedback: API reference | Example doesn't match the description Feb 15, 2022
@patiencedaur patiencedaur added the example Problem with a code example. label Feb 28, 2022
@TarantoolBot TarantoolBot removed the 3sp label Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add details [nature] More details needed, some info missing. Documentation is incomplete. ecosystem [area] Task relates to Tarantool's ecosystem (connector, module, other non-server functionality) example Problem with a code example. vshard [area] Related to vshard module
Projects
None yet
Development

No branches or pull requests

4 participants