tarantool / tarantool/doc

introduce line carrying slash

Open
#3,392 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.0 feature
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Related dev. issue(s): https://github.com/tarantool/tarantool/issues/4317

Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/reference/tooling/interactive_console/
SME: @ Lord-KA

Details

Now we can use multiline commands with lines ending by configuring
continuation symbol. Works only when there is no set delimiter.
Consider the example where the marker is set, used and removed:

tarantool> \set continuation on
---
- true
...

tarantool> a = 10\
         > + 12
---
...

tarantool> \set continuation off
---
- true
...

tarantool> a = 10\
---
- error: '[string "a = 10\"]:1: unexpected symbol near ''\'''
...

tarantool>

Requested by @ Lord-KA in https://github.com/tarantool/tarantool/commit/56a43147444141ada97d5f03faa0dd218dbbcc89.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the interactive console root document linked in the issue and review related development issue #4317 for context. Use the shown continuation-on and continuation-off examples to determine what behavior and limitations the documentation should cover; done means the console's line-continuation behavior is accurately described.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.