[5pt] feedback: Module cartridge.argparse | Tarantool
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Example for get_opts needed
Product: Cartridge
Since: ?
Audience/target: developers
Root document: https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_api/modules/cartridge.argparse/
SME: @rosik
Peer reviewer:
Details
<…>
parse() -> {memtx_memory = "100", alias = "router"}
|get_cluster_opts()| -> {alias = "router"} -- a string
get_box_opts() -> {memtx_<…>
Нет примера для get_opts, что оно делает и чем отличается от parse() или get_cluster_opts()?
Definition of done
- Relevant examples for all the functions, namely, get_opts(), parse(), etc. are added
- Added explanation of use cases and the differense between the functions
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 root document at https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_api/modules/cartridge.argparse/ and review the existing documentation for get_opts(), parse(), get_cluster_opts(), and related functions. Add relevant examples and explain each function’s use cases and differences; done means all listed functions have examples and the requested explanations are present.
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