Skip to content

[8pt] Mark all built-in modules with information about yielding #1448

@rosik

Description

@rosik
Contributor

Make fiber stuff well-described again

Product: Tarantool
Since:
Audience/target: Lua devs
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/fiber/
SME: @rosik
Peer reviewer: @ documentarian name

Details

Documentation about implicit cases is very poor. I believe it deserves another chapter in doc.

What information I'd like to see there:

  • List ALL functions that yield explicitly. And when do they. For example, channel:get() is tricky and yields only occasionally.
  • Mark ALL those functions within their sections - fio, netbox, http, socket, log (!), etc.
  • Every implicit yield may raise upon wakeup if the fiber was cancelled.
  • fiber.cancel doesn't yield, but still raises "fiber is cancelled" error.
  • Please mention requirements for triggers too.

Definition of done

Activity

added
design[nature] Design issue
manual[location] Tarantool manual, no definite location
server[area] Task relates to Tarantool's server (core) functionality
on Aug 11, 2020
changed the title [-]Make fiber stuff well-described again[/-] [+][64pt] Make fiber stuff well-described again[/+] on Aug 17, 2020
Totktonada

Totktonada commented on Sep 8, 2020

@Totktonada
Member

I would also create a documentation page, which describes how fibers serve requests.

Totktonada

Totktonada commented on Nov 13, 2020

@Totktonada
Member

Related: #1648.

changed the title [-][64pt] Make fiber stuff well-described again[/-] [+]Make fiber stuff well-described again[/+] on Mar 5, 2021
changed the title [-]Make fiber stuff well-described again[/-] [+][13pt] Make fiber stuff well-described again[/+] on Mar 5, 2021
artur-barsegyan

artur-barsegyan commented on Mar 10, 2021

@artur-barsegyan
Contributor

This is another task that cannot be done with the help of documentaries. Documenters do not have the competence to determine exactly whether a yield is a function or not.

I see a simple solution:

  • come up with how we will write in the reference that the function can be displayed
  • create a google sheet with tabs for each module in Tarantool
  • give a link to the required tabs for each subcommand in Core

Then transfer this information to rST.

artur-barsegyan

artur-barsegyan commented on Mar 10, 2021

@artur-barsegyan
Contributor

And we should rename this issue into "Mark all built-in modules with information about yielding"

changed the title [-][13pt] Make fiber stuff well-described again[/-] [+][13pt] Mark all built-in modules with information about yielding[/+] on Mar 26, 2021
rosik

rosik commented on Mar 26, 2021

@rosik
ContributorAuthor

Please mention requirements for triggers too.

changed the title [-][13pt] Mark all built-in modules with information about yielding[/-] [+][8pt] Mark all built-in modules with information about yielding[/+] on Mar 26, 2021
self-assigned this
on Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    design[nature] Design issuemanual[location] Tarantool manual, no definite locationserver[area] Task relates to Tarantool's server (core) functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @Totktonada@rosik@NickVolynkin@artur-barsegyan@lenkis

        Issue actions

          [8pt] Mark all built-in modules with information about yielding · Issue #1448 · tarantool/doc