Skip to content

Fix BigQuery API (and others) not showing in Parsons Documentation#1827

Merged
shaunagm merged 13 commits intomove-coop:mainfrom
bmos:bigquery_docs
Apr 15, 2026
Merged

Fix BigQuery API (and others) not showing in Parsons Documentation#1827
shaunagm merged 13 commits intomove-coop:mainfrom
bmos:bigquery_docs

Conversation

@bmos
Copy link
Copy Markdown
Collaborator

@bmos bmos commented Apr 11, 2026

#1721 broke our documentation build, which needs access to all our dependencies.

What is this change?

  • Install parsons with all extras during build job of documentation workflow
  • Improve type hints
  • Improve docstrings
  • Remove unused variables
  • Pass **load_kwargs to load_table_from_file() as described in docstring
  • Mark static methods with @staticmethod

How to test the changes (if needed)

  • CI tests should be adequate

Breaking Changes

Breaking changes are changes to our public API which may require existing users to change their code. If there are no breaking changes, any existing parsons user should not need to do anything after updating their parsons version.

Does this PR introduce breaking changes?
  • label: Breaking change — This PR introduces one or more breaking changes.
  • label: Non-breaking change — This PR does not introduce one or more breaking changes.

Details (if needed)

@github-actions github-actions bot added documentation Work type - improvements or additions to documentation python Pull requests that update Python code non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. labels Apr 11, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 11, 2026

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  parsons/google
  google_bigquery.py 67, 902, 980, 1779-1784, 1793-1818
Project Total  

This report was generated by python-coverage-comment-action

@github-actions github-actions bot added non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. and removed non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. labels Apr 11, 2026
@github-actions github-actions bot added github_actions Pull requests that update GitHub Actions code non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. labels Apr 11, 2026
@bmos bmos changed the title Fix BigQuery API in Parsons Documentation Fix BigQuery API (and others) not showing in Parsons Documentation Apr 11, 2026
@bmos bmos marked this pull request as ready for review April 11, 2026 14:56
@github-actions github-actions bot removed the non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. label Apr 11, 2026
@shaunagm shaunagm added the non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. label Apr 15, 2026
@github-actions github-actions bot removed the non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. label Apr 15, 2026
@shaunagm
Copy link
Copy Markdown
Collaborator

@bmos can you confirm this should be a non-breaking change?

@bmos
Copy link
Copy Markdown
Collaborator Author

bmos commented Apr 15, 2026

I changed the names of functions that are not intended for public use. It would be breaking if someone was using those utility functions. If desired, I can add deprecation aliases to make it 100% not breaking even in that edge case.

@bmos bmos marked this pull request as draft April 15, 2026 02:31
@shaunagm
Copy link
Copy Markdown
Collaborator

Yes please - or separate them out into two PRs so we can fix the broken docs quickly and wait until the next major release for the (admittedly very minor) breaking change.

@bmos
Copy link
Copy Markdown
Collaborator Author

bmos commented Apr 15, 2026

That's probably the better approach, they're not really in scope and I didn't think of them as breaking when I made them

@bmos bmos marked this pull request as ready for review April 15, 2026 16:23
@github-actions github-actions bot added non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. and removed non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. labels Apr 15, 2026
@shaunagm
Copy link
Copy Markdown
Collaborator

Thanks for making the changes @bmos!

@shaunagm shaunagm merged commit a5f9dc1 into move-coop:main Apr 15, 2026
102 of 107 checks passed
@bmos bmos deleted the bigquery_docs branch April 15, 2026 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Work type - improvements or additions to documentation github_actions Pull requests that update GitHub Actions code non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. python Pull requests that update Python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants