The translation is temporarily closed for contributions due to maintenance, please come back later.
The translation was automatically locked due to following alerts: Could not merge the repository.
Zen

Source string Source string

10/10000 · 10
English Actions
Examples and templates
This document contains general guidelines for describing the Tarantool API, as well as examples and templates.
Use this checklist for documenting a function or a method:
Base description
Parameters
What this function returns (if nothing, write 'none')
Return type (if exists)
Possible errors (if exist)
Complexity factors (if exist)
Usage with memtx and vinyl (if differs)
Example(s)
Extra information (if needed)
Documenting functions
We use the Sphinx directives ``.. module::`` and ``.. function::`` to describe functions of Tarantool modules:
.. module:: fiber

.. function:: create(function [, function-arguments])

Create and start a fiber. The fiber is created and begins to run immediately.

:param function: the function to be associated with the fiber
:param function-arguments: what will be passed to function

:return: created fiber object
:rtype: userdata

**Example:**

.. code-block:: tarantoolsession

tarantool> fiber = require('fiber')
---
...
tarantool> function function_name()
> print("I'm a fiber")
> end
---
...
tarantool> fiber_object = fiber.create(function_name); print("Fiber started")
I'm a fiber
Fiber started
---
...
The resulting output looks like this:
Create and start a fiber. The fiber is created and begins to run immediately.
the function to be associated with the fiber
what will be passed to function
return
created fiber object
rtype
userdata
**Example:**
tarantool> fiber = require('fiber')
---
...
tarantool> function function_name()
> print("I'm a fiber")
> end
---
...
tarantool> fiber_object = fiber.create(function_name); print("Fiber started")
I'm a fiber
Fiber started
---
...
Documenting class methods and data

Loading…

Things to check

Unpluralised

The string is used as plural, but not using plural forms

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 11