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

chore: pin sphinx plugin version to working one #715

Merged
merged 1 commit into from Jun 24, 2021
Merged

Conversation

dandhlee
Copy link
Contributor

There's an issue with the current gcp-sphinx-docfx-yaml version failing for the following text:

        """Union[int, None]: Expiration time in milliseconds for a partition.

        If :attr:`partition_expiration` is set and :attr:`type_` is
        not set, :attr:`type_` will default to
        :attr:`~google.cloud.bigquery.table.TimePartitioningType.DAY`.
        """

which gets converted to

Union[int, None]: Expiration time in milliseconds for a partition.


If <xref:partition_expiration> is set and <xref:type_> is
not set, <xref:type_> will default to
<xref:google.cloud.bigquery.table.TimePartitioningType.DAY>.

which fails on the plugin because it thinks <xref:type_> should be a token it needs to process. The docstring is not malformed, the plugin needs additional work.

I'll have a fix for this by the end of the day, but should you need to submit PRs then please merge this one to have yourself unblocked!

Unblocks #698 🦕

@dandhlee dandhlee requested a review from a team June 22, 2021 15:26
@dandhlee dandhlee requested a review from a team as a code owner June 22, 2021 15:26
@dandhlee dandhlee requested review from stephaniewang526 and removed request for a team June 22, 2021 15:26
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Jun 22, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Jun 22, 2021
@plamut
Copy link
Contributor

plamut commented Jun 23, 2021

Thanks for this!

As mentioned in the chat, it's fine for now and we can wait for the proper fix. But if the latter gets significantly delayed for some reason, we'll use this one as a workaround.

@dandhlee
Copy link
Contributor Author

googleapis/sphinx-docfx-yaml#55 is ready for review, once that's submitted and released it should be good! Hopefully it won't take too long.

@jimfulton jimfulton merged commit 5e9494e into master Jun 24, 2021
@jimfulton jimfulton deleted the dandhlee-patch-1 branch June 24, 2021 12:08
dandhlee added a commit that referenced this pull request Jun 24, 2021
jimfulton pushed a commit that referenced this pull request Jun 24, 2021
emkornfield pushed a commit to emkornfield/python-bigquery that referenced this pull request Feb 11, 2023
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. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants