Skip to content

Types in return statements #791

Open
@mauicv

Description

As per our CONTRIBUTING.md we say:

Returning an object which contains multiple attributes and each attribute is described individually. In this case the attribute name is written between single back-ticks and the type, if provided, would be written in double back-ticks.

The language here makes it optional and we currently don't typically add types for return values that are contained in dicts, instead just opting to describe them. We should update this across the code base to be more specific. This would also mean updating the language here to make it clear that this isn't optional.

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