Skip to content

[2pt] Create a guideline for describing Tarantool configuration parameters #2723

Closed
@veod32

Description

@veod32

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:

  • 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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions