Skip to content

How to describe errors in documentation #1810

Open
@Onvember

Description

@Onvember

When documenting a function for Tarantool reference, we have the "Possible errors" section. But for now we don't have a unified style of describing them. I think, we should agree on how to do this and update our documentation guidelines.

Linked issues:
#1703 (comment)
#1348

@ veod32 in #3024 (comment) says:
Possible errors can be related to the entire function/method, not necesserily to the misuse of some parameters.
See, for example,

https://www.tarantool.io/en/doc/latest/book/connectors/cxx/tntcxx_api/#public-methods
https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/pairs/

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions