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

GoogleDocstring does not handle new xref format well #89

Closed
dandhlee opened this issue Jul 29, 2021 · 0 comments · Fixed by #90
Closed

GoogleDocstring does not handle new xref format well #89

dandhlee opened this issue Jul 29, 2021 · 0 comments · Fixed by #90
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

Previously, when xrefs were included for GoogleDocstring it crashed, not knowing how to process it. To work around this, I've took xrefs out of the equation, ran GoogleDocstring, then added them back in. Tedious, but worked. Also included test cases.

However, with the new format of xrefs with <xref uid="uid">text</xref>, this was not considered as the previous grep for "xref:" were the only ones included in the unit test, and not with the new format, thus it hasn't worked out well.

Interestingly enough, I'm not sure why it took ~60 repos to find that this would fail, rather than it failing before...

@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 Jul 29, 2021
@dandhlee dandhlee self-assigned this Jul 29, 2021
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