Skip to content

Fix style of crdb_internal.probe_ranges generated function documentation #84758

@ghost

Description

Describe the problem

The definition for crdb_internal.probe_ranges added in #79546 should follow the documentation style (that is, a 1 line definition) used by other functions. This does not conform to the style of the other definitions:

https://www.cockroachlabs.com/docs/stable/functions-and-operators.html#tuple-int-as-range_id-string-as-error-int-as-end_to_end_latency_ms-string-as-verbose_trace-functions

The heading over the table should not include the function signature, but should be TUPLE Functions.

If more detailed documentation is required it should be added in a separate documentation page, not the function reference.

Jira issue: CRDB-17848

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-observability-infC-bugCode not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions