Skip to content

Provide Doc Examples for All Public Module Functions #3

@tajacks

Description

@tajacks

Determine a consistent style for documenting functions that return large response structs or binary data. There should be a consistent visual style to indicate that data was cut off.

Implement and ensure that tests cover all documentation examples, as DocTests likely won't be possible if responses are truncated.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions