You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Create a guideline for describing Tarantool configuration parameters and API function parameters (:param:).
We already have templates for documenting functions, classes, methods, and data. But description of configuration parameters has its own specifics. The following info should be provided for each parameter:
Since which Tarantool version
General description with all the details and examples (if needed)
Type
Corresponding environment variable
Default value
Dynamic (yes or no)
Possible errors
The text was updated successfully, but these errors were encountered:
veod32
changed the title
[0pt] {feature_name}
[2pt] Create a guideline for describing Tarantool configuration parameters
Feb 24, 2022
Root document: https://www.tarantool.io/en/doc/latest/contributing/docs/examples/
ToDo
Create a guideline for describing Tarantool configuration parameters and API function parameters (
:param:
).We already have templates for documenting functions, classes, methods, and data. But description of configuration parameters has its own specifics. The following info should be provided for each parameter:
The text was updated successfully, but these errors were encountered: