[2pt] feedback: Module cartridge.confapplier | Tarantool
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Cartridge
Audience/target: dev
Root document: https://www.tarantool.io/ru/doc/latest/book/cartridge/cartridge_api/modules/cartridge.confapplier/
SME: @ sergos ?
Details
Seems like "perform state transition" might be not descriptive enough. We might need to explain briefly what this action means.
<…>
Returns:
(table)Local Functions
set_state (state[, err])
|Perform state transition.|
Parameters:state: (string) New state
err: (optional)Retur<…>
https://www.tarantool.io/ru/doc/latest/book/cartridge/cartridge_api/modules/cartridge.confapplier/
Что оно делает?
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 root document for cartridge.confapplier and review the local set_state(state[, err]) entry, especially its current “Perform state transition” description. Clarify briefly what the action does, using the documented state and err parameters; the documentation should explain the action more descriptively than the current wording.
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
- 35/100