tarantool / tarantool/doc

feedback: box.error()

Open
#3,875 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Product: Tarantool
Since: n/a
Audience/target: developers
Root document: https://www.tarantool.io/ru/doc/latest/reference/reference_lua/box_error/error/#lua-function.box.error
SME: @

Details

<…>

box.error()

box.error()
|Raise the last error.
|See
also: box.error.last()

box.error(error_object)
Raise th<…>

https://www.tarantool.io/ru/doc/latest/reference/reference_lua/box_error/error/#lua-function.box.error

I believe that it should be mentioned that is fiber-local. Otherwise that API feels confusing and does not make sense for a reader that expects it to run via cooperative multitasking

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 referenced box.error() documentation at the Tarantool root document URL and review the descriptions of box.error() and box.error.last(). Update the explanation to state that the last error is fiber-local, then verify that the resulting wording removes the cooperative-multitasking ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.