tarantool / tarantool/doc

[3pt] feedback: Module net.box | Revise the net_box/#lua-function.conn.request section

Open
#2,286 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

example netbox reference rewrite
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: Tarantool
Since: 2.9.1?
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/net_box/#lua-function.conn.request
SME: @ locker

Details

<…>it for the remote
server response, not the request itself.

|conn:request(... {is_async=...})|
{is_async=true|false} is an option which is applicable for all
<…>

https://www.tarantool.io/en/doc/latest/reference/reference_lua/net_box/

This section needs a revision after https://github.com/tarantool/tarantool/issues/6241. At least the example is different now.

@rosik

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 net_box/#lua-function.conn.request section in the Tarantool documentation and review issue #6241 for the behavior change. Compare the current text and example, including the is_async option, with the updated behavior described there. Done means the section and example accurately reflect the current conn:request API.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.