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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

keyword rendering in hosted docs #1662

Closed
SaskiaKeil opened this issue Sep 19, 2023 · 2 comments · Fixed by #1829
Closed

keyword rendering in hosted docs #1662

SaskiaKeil opened this issue Sep 19, 2023 · 2 comments · Fixed by #1829
Assignees
@kiraksi
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@SaskiaKeil
Copy link

Steps to reproduce

  1. Open this page:
  2. Check the content of the query param, you can see that it not only includes the query param, but all other kwargs arguments too. I don't think this formatting is supposed to look like it. Docs in the code look fine

I couldn't really figure out which technology is used for the doc rendering, so I wasn't able to propose a change myself.
But looks like the used markdown doesn't work in this case. This might require an update of the docstrings.
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Sep 19, 2023
@meredithslota meredithslota added the type: docs Improvement to the documentation for an API. label Sep 22, 2023
@chalmerlowe chalmerlowe added the priority: p3 Desirable enhancement or fix. May not be included in next release. label Sep 28, 2023
@kiraksi kiraksi self-assigned this Oct 29, 2023
@kiraksi
Copy link
Contributor

kiraksi commented Jan 17, 2024

As a followup, waiting on @dandhlee to work on this together at some point before the end of my internship

@kiraksi kiraksi mentioned this issue Feb 25, 2024
Merged
4 tasks
@SaskiaKeil
Copy link
Author

thx for taking care :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kiraksi kiraksi

Labels
api: bigquery Issues related to the googleapis/python-bigquery API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: keyword rendering and docstring improvements kiraksi/python-bigquery
4 participants
@SaskiaKeil @meredithslota @chalmerlowe @kiraksi