tarantool / tarantool/doc

[2pt] Explain that functions in osmodule are not async

Open
#1,998 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Explain that functions in osmodule are not async

Product: Tarantool, osmodule
Audience/target:
Root document: https://www.tarantool.io/ru/doc/latest/reference/reference_lua/osmodule/
SME: @ expert to ask for more information
Peer reviewer: @ documentarian name

Details

Не тривиально, что функции из этого модуля не асинхронны. Лучше добавить информацию об этом в документацию.

https://app.mopinion.com/dashboard/inbox/detail/4386545

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

Open the osmodule root document at the linked Tarantool documentation URL and review its function descriptions. Add a clear explanation that these functions are not asynchronous, then verify the note is visible in the osmodule documentation and matches the issue’s intended audience.

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
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.