Function _sample_docs

packages/node/tests/protocol/test_dsl.py:43–67

(**overrides)

def _sample_docs(**overrides) -> dsl_interpreter_operator_docs.OperatorDocs:
    data = {
        "name": "rsi",
        "description": "Relative Strength Index",
        "type": "ta",
        "example": "rsi(data, 14)",
        "parameters": [
            _sample_parameter(
                name="data",
                parameter_type=commons_enums.DslValueType.SERIES.value,
            )
        ],
        "label": "RSI",
        "category": commons_enums.DslKeywordCategory.SOURCE.value,
        "return_values": [
            dsl_interpreter_operator_parameter.OperatorParameter(
                name="result",
                description="RSI series",
                required=True,
                type=commons_enums.DslValueType.SERIES.value,
            )
        ],
    }
    data.update(overrides)
    return dsl_interpreter_operator_docs.OperatorDocs(**data)


class TestListDslOperatorDocs: