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

plugin parses docstring differently than expected #52

Closed
dandhlee opened this issue Jun 22, 2021 · 1 comment · Fixed by #55
Closed

plugin parses docstring differently than expected #52

dandhlee opened this issue Jun 22, 2021 · 1 comment · Fixed by #55
Assignees
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@dandhlee
Copy link
Collaborator

With the given docstring:

        """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`.
        """

It fails to parse properly and treat the whole syntax as a top line summary when it encounters xref:type_ since we look for :type in the code. This should be prevented by only looking for :type and nothing before/after.

@dandhlee dandhlee added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. labels Jun 22, 2021
@dandhlee dandhlee self-assigned this Jun 22, 2021
@dandhlee
Copy link
Collaborator Author

Issue first seen in googleapis/python-bigquery#698

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to 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