Skip to content

review metadata api docstrings before release #1357

@jku

Description

@jku

This came up in #1354: let's check that our api docstrings are consistent -- the specific case was "Optional" in the docstring:

        Arguments:
            data: metadata content as string.
            deserializer: Optional; A MetadataDeserializer instance that...

This is from a google style guide example and is used when the argument has a default value (not when the argument is a Optional[T]).

Metadata

Metadata

Assignees

No one assigned

    Labels

    backlogIssues to address with priority for current development goals

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions