Add tt CLI docs #2973
Add tt CLI docs #2973
Conversation
| ``-i`` | ||
| - Force the use of an internal module even if there is an external module with the same name. | ||
| .. // TODO: add link to external modules doc page when it's ready | ||
| * - ``--local=DIRECTORY`` |
There was a problem hiding this comment.
I don't know if that's normal or not.
There was a problem hiding this comment.
thanks, fixed the layout
doc/reference/tt_cli/index.rst
Outdated
|
|
||
| ``tt`` is going to become a single tool for working with Tarantool | ||
| from the command line and replace :doc:`tarantoolctl </reference/tarantoolctl>` and | ||
| :doc:`Cartridge CLI </book/cartridge/cartridge_cli/index>` in the future. |
There was a problem hiding this comment.
It's unsafe to leave relative remarks about time in the docs, like "now" and "in the future". What ir the user reads it in the said future, and the doc hasn't been updated yet? We can't catch all the "todays" and "nows" across the docs.
Please rephrase the sentence. The first option that comes to my mind is something like "It is envisioned as a tool that can potentially replace..." Feel free to use this or another option.
I'll add a style guideline discouraging the use of relative time adverbs. Here's a related issue: #2202
doc/reference/tt_cli/index.rst
Outdated
|
|
||
| .. warning:: | ||
|
|
||
| ``tt`` is currently in the early development stage. It includes |
There was a problem hiding this comment.
"Currently" is also relative. I would suggest using "as of [date]" instead or mentioning the release it was introduced in.
Co-authored-by: Dia Patience Daur <patiencedaur@gmail.com>
Co-authored-by: Dia Patience Daur <patiencedaur@gmail.com>
|
|
||
| .. code-block:: bash | ||
|
|
||
| . <(tt completion bash) |
Resolves #2554 #2976 #2555 #2566