Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
SinaChavoshi opened this issue Apr 30, 2021 · 0 comments · Fixed by #359
Closed

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

SinaChavoshi opened this issue Apr 30, 2021 · 0 comments · Fixed by #359
Labels
api: aiplatform Issues related to the AI Platform API. triage me I really want to be triaged.

Comments

@SinaChavoshi
Copy link
Contributor

SinaChavoshi commented Apr 30, 2021

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.
        """
@product-auto-label product-auto-label bot added the api: aiplatform Issues related to the AI Platform API. label Apr 30, 2021
@SinaChavoshi SinaChavoshi changed the title Docstring for a few of the methods is not parsable Docstring for a few of the methods are not parsable Apr 30, 2021
@yoshi-automation yoshi-automation added the triage me I really want to be triaged. label May 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: aiplatform Issues related to the AI Platform API. triage me I really want to be triaged.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants