tarantool / tarantool/doc

[3pt] introduce fiber_object:info() and fiber_object:csw()

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

Nobody has claimed this yet.

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

Description

New fiber_object:info() and fiber_object:csw() functions

Product: Tarantool
Since: 2.9.0-43-g9da7e03e8
Audience/target: Tarantool users
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/fiber/#lua-object.fiber.fiber_object
SME: @ Korablev77

Details

  • fiber_object:info() is the same as fiber.info(), but show information only
    about one alive fiber.
  • fiber_object:csw() show csw (Context SWitch) of alive fiber.

Definition of done

  • New fiber_object:info() and fiber_object:csw() functions are desribed.

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 at the fiber_object reference section linked in the issue and compare the existing fiber.info() and fiber.csw() documentation. Add descriptions for fiber_object:info() and fiber_object:csw(), covering that they report information or context switches for one alive fiber. Done means both functions are described in the reference documentation.

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
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.