Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

fix: make plugin more verbose#123

Merged
dandhlee merged 4 commits into
mainfrom
make_plugin_more_verbose
Aug 30, 2021
Merged

fix: make plugin more verbose#123
dandhlee merged 4 commits into
mainfrom
make_plugin_more_verbose

Conversation

@dandhlee
Copy link
Copy Markdown
Collaborator

@dandhlee dandhlee commented Aug 27, 2021

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 a team, busunkim96, parthea and tbpg 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
Copy Markdown
Collaborator Author

dandhlee commented Aug 30, 2021 •
edited
Loading

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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@busunkim96 busunkim96 Awaiting requested review from busunkim96

@tbpg tbpg Awaiting requested review from tbpg

1 more reviewer

@parthea parthea parthea approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

The plugin doesn't show enough docstrings to help debug

2 participants

@dandhlee @parthea