Remove None & NoneType from parameter types in docstrings. - #2584
Merged
dhermes merged 3 commits intoOct 21, 2016
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
This runs a script to remove None from the types for parameters, and added (Optional) to the description. Does not pass lint due to some too-long lines. I will clean those up manually. See: googleapis#2580 (review)
It looks like there was a mistake in copy-pasting parameter documentation. All the descriptions were for the expiration time.
Mostly, lines that were too long.
dhermes
approved these changes
Oct 21, 2016
Copy link
Copy Markdown
Contributor
Author
|
@dhermes Okay to merge? Travis looks happy. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
@tswast Am I crazy: $ git grep -l NoneType bigquery/google/cloud/bigquery/client.py bigquery/google/cloud/bigquery/dataset.py bigquery/google/cloud/bigquery/job.py bigquery/google/cloud/bigquery/query.py bigquery/google/cloud/bigquery/table.py bigtable/google/cloud/bigtable/client.py bigtable/google/cloud/bigtable/column_family.py bigtable/google/cloud/bigtable/table.py core/google/cloud/_helpers.py core/google/cloud/client.py core/google/cloud/connection.py datastore/google/cloud/datastore/client.py datastore/google/cloud/datastore/key.py datastore/google/cloud/datastore/query.py dns/google/cloud/dns/changes.py dns/google/cloud/dns/client.py dns/google/cloud/dns/zone.py error_reporting/google/cloud/error_reporting/client.py logging/google/cloud/logging/client.py logging/google/cloud/logging/logger.py logging/google/cloud/logging/metric.py logging/google/cloud/logging/sink.py monitoring/google/cloud/monitoring/client.py pubsub/google/cloud/pubsub/client.py pubsub/google/cloud/pubsub/subscription.py pubsub/google/cloud/pubsub/topic.py resource_manager/google/cloud/resource_manager/client.py resource_manager/google/cloud/resource_manager/project.py scripts/rewrite_imports.py speech/google/cloud/speech/client.py storage/google/cloud/storage/_helpers.py storage/google/cloud/storage/acl.py storage/google/cloud/storage/blob.py storage/google/cloud/storage/bucket.py storage/google/cloud/storage/client.py vision/google/cloud/vision/client.py $ git log -1 --pretty=%H 1fab75689b56bc67d08e4726175b4a41a82fbef7 |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
Not crazy, I noticed a few, too, since sending that PR. Most are :rtype: which I didn't remove (waiting until we decide how to document these) and some are where the NoneType spilled onto a second line from the parameter type. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
Ouch, I see some lines like :type message: Protobuf message or :class:NoneType`` I'm somewhat surprise the script didn't catch these. Although, I guess this one is because the first type has a space in it. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
No worries, at least we made it some of the way to the finish line? |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
Yeah 407 lines of progress. :-) |
Sorry, something went wrong.
richkadel
pushed a commit
to richkadel/google-cloud-python
that referenced
this pull request
May 6, 2017
Remove None & NoneType from parameter types in docstrings.
parthea
pushed a commit
that referenced
this pull request
Oct 21, 2023
Remove None & NoneType from parameter types in docstrings.
parthea
pushed a commit
that referenced
this pull request
Nov 24, 2025
Remove None & NoneType from parameter types in docstrings.
parthea
pushed a commit
that referenced
this pull request
Nov 24, 2025
Remove None & NoneType from parameter types in docstrings.
parthea
pushed a commit
that referenced
this pull request
Nov 24, 2025
Remove None & NoneType from parameter types in docstrings.
parthea
pushed a commit
that referenced
this pull request
Nov 24, 2025
Remove None & NoneType from parameter types in docstrings.
parthea
pushed a commit
that referenced
this pull request
Mar 2, 2026
Remove None & NoneType from parameter types in docstrings.
parthea
pushed a commit
that referenced
this pull request
Mar 9, 2026
Remove None & NoneType from parameter types in docstrings.
ohmayr
pushed a commit
that referenced
this pull request
Mar 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 more reviewer3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Based on comment: #2580 (review)
Uses this script:
https://gist.github.com/tswast/fa8bd1cbdf84e0777109d217c2271622
I manually adjusted whitespace to fix lint errors.