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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

docs: add/reformat return types for cloud RAD docs #1582

Merged
merged 2 commits into from
Jun 9, 2023
Merged

docs: add/reformat return types for cloud RAD docs #1582

merged 2 commits into from
Jun 9, 2023

Conversation

leahecole
Copy link
Contributor

@leahecole leahecole commented Jun 8, 2023 •
edited

  • In order for the Return table to show up in the docs, the type of the return object must be in the Returns docstring
  • I also removed two examples from docstrings - they don't format properly in our docs and I felt they were encompassed in other samples. If we want to keep them we can, I'll just need to reach out to the Cloud RAD team to understand how they need to be formatted

Fixes #1438 once the Cloud RAD job runs after this is merged 馃槃

@product-auto-label product-auto-label bot added size: s Pull request size is small. api: bigquery Issues related to the googleapis/python-bigquery API. labels Jun 8, 2023
@leahecole leahecole requested a review from tswast June 8, 2023 19:56
@leahecole leahecole marked this pull request as ready for review June 8, 2023 19:56
@leahecole leahecole requested review from a team as code owners June 8, 2023 19:56
tswast
tswast approved these changes Jun 8, 2023
View reviewed changes
Copy link
Contributor

@tswast tswast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@leahecole leahecole merged commit 6efdce1 into main Jun 9, 2023
18 checks passed
@leahecole leahecole deleted the fix_262443211 branch June 9, 2023 15:01
@release-please release-please bot mentioned this pull request Jun 9, 2023
Merged
This was referenced Jun 21, 2023
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tswast tswast tswast approved these changes

Assignees
No one assigned
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. size: s Pull request size is small.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing return types in some methods on cloud.google.com documentation
2 participants
@leahecole @tswast