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

fix: make plugin more verbose #123

Merged
merged 4 commits into from
Aug 30, 2021
Merged

fix: make plugin more verbose #123

merged 4 commits into from
Aug 30, 2021

Conversation

dandhlee
Copy link
Collaborator

When folks are debugging it's hard to see which part of the docstring there's an error, if they're given only a short snippet. To help track down where the issue originates from, while the original docstring is lost, I've tried to include as much information as possible to help track down where the broken docstring lives in.

Example of additional output with the updated format:

ValueError: In google/cloud/bigquery/job/copy_.py
For module google.cloud.bigquery.job, type method:
Failed to parse docstring on google.cloud.bigquery.job.CopyJob.from_api_repr.

Fixes #122.

CC @jimfulton

@dandhlee dandhlee requested review from parthea, busunkim96, tbpg and a team August 27, 2021 22:36
@dandhlee dandhlee requested a review from a team as a code owner August 27, 2021 22:36
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Aug 27, 2021
@dandhlee
Copy link
Collaborator Author

dandhlee commented Aug 30, 2021

string append using += can be quadratic runtime, where as string append using an array and "".join(string_array) is linear run time. 😮

See https://google.github.io/styleguide/pyguide.html#310-strings

Will include this to part of #118.

@dandhlee dandhlee merged commit 1f25757 into main Aug 30, 2021
@dandhlee dandhlee deleted the make_plugin_more_verbose branch August 30, 2021 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The plugin doesn't show enough docstrings to help debug
2 participants