feat: remove D205 to enable PEP257 Docstring Conventions #2045

ahsan-z-khan · 2020-12-18T19:37:50Z

Issue #, if available: 1981

Description of changes: Removed D205 from pydocstyle to follow the PEP257 docstring conventions for future docstrings.

Testing done: Unit tests

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

I have read the CONTRIBUTING doc
I used the commit message format described in CONTRIBUTING
I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

I have added tests that prove my fix is effective or that my feature works (if appropriate)
I have checked that my tests are not configured for a specific region or account (if appropriate)
I have used unique_name_from_base to create resource names in integ tests (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

sagemaker-bot · 2020-12-18T19:46:36Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: 326d0ae
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T19:51:09Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: 326d0ae
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T20:15:39Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: 326d0ae
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T20:19:14Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: 4559a40
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T20:23:30Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: 4559a40
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

src/sagemaker/session.py

src/sagemaker/xgboost/estimator.py

sagemaker-bot · 2020-12-18T20:49:24Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: 4559a40
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:09:30Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: 4559a40
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:17:14Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: f76e76c
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:17:54Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: a0f3b14
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

metrizable · 2020-12-18T21:39:36Z

src/sagemaker/session.py

@@ -195,7 +192,6 @@ def upload_data(self, path, bucket=None, key_prefix="data", extra_args=None):
                Similar to ExtraArgs parameter in S3 upload_file function. Please refer to the
                ExtraArgs parameter documentation here:
                https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-uploading-files.html#the-extraargs-parameter
-


this line should not be removed

metrizable · 2020-12-18T21:39:46Z

src/sagemaker/session.py

@@ -278,9 +273,7 @@ def download_data(self, path, bucket, key_prefix="", extra_args=None):
                download operation. Please refer to the ExtraArgs parameter in the boto3
                documentation here:
                https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-example-download-file.html
-


same with this and elsewhere. blank line before Returns

sagemaker-bot · 2020-12-18T21:53:23Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: f76e76c
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:54:50Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: a0f3b14
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:54:55Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: f76e76c
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:55:27Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: a0f3b14
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:58:19Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: 3dac1b5
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T21:58:44Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: 0316698
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

metrizable · 2020-12-18T21:58:26Z

src/sagemaker/session.py

@@ -280,7 +277,6 @@ def download_data(self, path, bucket, key_prefix="", extra_args=None):
                https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-example-download-file.html

        Returns:
-


i think you should not have a Returns: section if you're not going to put anything in it, or have:

Returns: None

ah that's understandable. I didn't remove it.

metrizable · 2020-12-18T21:58:57Z

src/sagemaker/session.py

@@ -1586,7 +1565,6 @@ def auto_ml(
                pairs.

        Returns:
-


same comment as above

metrizable · 2020-12-18T22:09:01Z

src/sagemaker/session.py

        The endpoint configuration identifies the Amazon SageMaker model (created using the
        ``CreateModel`` API) and the hardware configuration on which to deploy the model. Provide
        this endpoint configuration to the ``CreateEndpoint`` API, which then launches the
        hardware and deploys the model.
-


need this blank line

metrizable · 2020-12-18T22:09:13Z

src/sagemaker/session.py


+        IT also updates any values that were passed in.


Suggested change

IT also updates any values that were passed in.

It also updates any values that were passed in.

sagemaker-bot · 2020-12-18T22:34:36Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: 3dac1b5
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T22:35:44Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: 0e4b894
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T22:35:50Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-unit-tests
Commit ID: fd84b53
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T22:37:15Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: 0316698
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T22:37:53Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: 0316698
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T22:43:12Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: 3dac1b5
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T23:04:21Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: 0e4b894
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T23:06:52Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: fd84b53
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T23:07:51Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-local-mode-tests
Commit ID: 0e4b894
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T23:08:22Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-notebook-tests
Commit ID: fd84b53
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

sagemaker-bot · 2020-12-18T23:25:18Z

AWS CodeBuild CI Report

CodeBuild project: sagemaker-python-sdk-pr
Commit ID: 0e4b894
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

ahsan-z-khan and others added 7 commits December 18, 2020 09:41

doc: update docstrings to comply with PEP257

a47a4fa

Remove/Edit docstrings to be compatible with PEP257

275f6d3

doc: modified docstrings to comply with PEP257 standards

425bf38

doc: modified docstrings to comply with PEP257 standards

2fa95f5

doc: modified docstrings to comply with PEP257 standards

c49aafe

doc: modified docstrings to comply with PEP257 standards

ffc7fdb

fix: fixed conflicts to comply with latest version

326d0ae

ahsan-z-khan linked an issue Dec 18, 2020 that may be closed by this pull request

additional docstyle improvements #1981

Closed

ahsan-z-khan requested a review from metrizable December 18, 2020 19:41

metrizable suggested changes Dec 18, 2020

View reviewed changes

src/sagemaker/session.py Outdated Show resolved Hide resolved

metrizable suggested changes Dec 18, 2020

View reviewed changes

src/sagemaker/xgboost/estimator.py Outdated Show resolved Hide resolved

fix: edited according to the changes requested

f76e76c

metrizable reviewed Dec 18, 2020

View reviewed changes

doc: edit docstrings to add blank line

3dac1b5

metrizable reviewed Dec 18, 2020

View reviewed changes

metrizable suggested changes Dec 18, 2020

View reviewed changes

ahsan-z-khan added 2 commits December 18, 2020 14:26

fix: addessed changes

fd84b53

Merge branch 'master' into D205-remove

0e4b894

metrizable approved these changes Dec 18, 2020

View reviewed changes

ahsan-z-khan merged commit 9dead38 into aws:master Dec 18, 2020

ahsan-z-khan deleted the D205-remove branch December 18, 2020 23:52

		@@ -280,7 +277,6 @@ def download_data(self, path, bucket, key_prefix="", extra_args=None):
		https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-example-download-file.html

		Returns:

	IT also updates any values that were passed in.
	It also updates any values that were passed in.

feat: remove D205 to enable PEP257 Docstring Conventions #2045

feat: remove D205 to enable PEP257 Docstring Conventions #2045

Uh oh!

Conversation

ahsan-z-khan commented Dec 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Checklist

General

Tests

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

Uh oh!

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

metrizable Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

Uh oh!

metrizable Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

ahsan-z-khan Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

metrizable Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

sagemaker-bot commented Dec 18, 2020

AWS CodeBuild CI Report

ahsan-z-khan commented Dec 18, 2020 •

edited

Loading