Skip to content

Docstring for a few of the methods are not parsable #358

@SinaChavoshi

Description

@SinaChavoshi

Docstring for a few of the methods under aiplatform are not parsable, which breaks API doc generation and parsing tools. For example in training_jobs.py the docstring

    def _raise_failure(self):
        """Helper method to raise failure if TrainingPipeline fails.

        Raises:
            RuntimeError If training failed.
        """

should be changed to

    def _raise_failure(self):
        """Helper method to raise failure if TrainingPipeline fails.

        Raises:
            RuntimeError: If training failed.
        """

Metadata

Metadata

Assignees

No one assigned

    Labels

    api: aiplatformIssues related to the AI Platform API.triage meI really want to be triaged.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions