feedback: Wrong information in fiber module description
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Audience/target: dev
Root document: https://www.tarantool.io/ru/doc/latest/reference/reference_lua/fiber/
SME: @ alyapunov
Details
More detailed info from the reporter:
"это работает, только если файбер был создан с помощью fiber.new() и стал доступным для присоединения путем fiber_object:set_joinable()." -- ошибочная информация
На самом деле join вместе с create() работает, и это более удобно, когда нужно запустить несколько файберов и дождаться результатов.
Не раскрыто, что убдет с join, если файбер уже успел выйти (ответ - все ок). Что будет, если вызвать join дважды (ответ - все упадет)
<…>.
Сейчас можно передать управление.Вызов fiber_object:join().
|Как правило, следует вызвать fiber_object:join(), в противном случае, статус файбера может перейти в „suspended“ (приостановлен) после выполнения функции, а не „dead“ (недоступен).|Параметры:
true_or_false – логическое значение, которое и<…>
https://www.tarantool.io/ru/doc/latest/reference/reference_lua/fiber/#fiber-object-set-joinable
Очень размытая формулировка. "Как правило" вообще убивает.
"может перейти в suspended". А может - и не перейти?
От чего это зависит, в какой ситуации будет какой расклад?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Russian fiber module page at the linked root document and its fiber-object:set-joinable section. Check the descriptions of join with fiber.create(), fibers that have already exited, repeated join calls, and the suspended/dead status wording; done means the documented behavior and conditions are precise and no longer rely on vague phrasing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100