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

missing docs for enums: switch to module-based reference docs for enums module #744

Closed
tswast opened this issue Jul 9, 2021 · 0 comments · Fixed by #745
Closed

missing docs for enums: switch to module-based reference docs for enums module #744

tswast opened this issue Jul 9, 2021 · 0 comments · Fixed by #745
Assignees
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@tswast
Copy link
Contributor

tswast commented Jul 9, 2021

There are several enums in https://github.com/googleapis/python-bigquery/blob/master/google/cloud/bigquery/enums.py which are undocumented.

I recall we were doing class-based docs mostly because the "jobs" module was too huge to properly browse. It should be safe to use module-based docs for the smaller modules like enums, so we don't have to keep remembering to keep reference.rst in sync.

@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Jul 9, 2021
@tswast tswast added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Jul 9, 2021
@tswast tswast changed the title switch to module-based reference docs for enums module missing docs for enums: switch to module-based reference docs for enums module Jul 9, 2021
@tswast tswast self-assigned this Jul 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant