Skip to content

DOC/Discussion: Update docstrings guide to include guidance for edge cases #28784

Open
@josibake

Description

@josibake

There are a few edge cases where there is not sufficient guidance in the docstrings on how to proceed. For example, if a parameter argument takes a list of values but the list is sufficiently long, it is not clear how to properly format (see #28739).

Opening this as a placeholder to document edge cases encountered while cleaning up docstrings and agree on what the convention should be.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions