feat: include the bigframes package version alongside the feedback link in error messages #936
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tswast
reviewed
Aug 30, 2024
There was a problem hiding this comment.
Please create a unit test verifying that FEEDBACK_LINK contains the version and that the version is not an empty string.
Create a test_constants.py file in this directory. https://github.com/googleapis/python-bigquery-dataframes/tree/main/tests/unit
| @@ -26,4 +29,5 @@ | ||
| "Abstract method. You have likely encountered a bug. " | ||
| "Please share this stacktrace and how you reached it with the BigQuery DataFrames team. " | ||
| f"{FEEDBACK_LINK}" | ||
| f"You are currently running BigFrames version {BF_VERSION}" |
There was a problem hiding this comment.
Please put this information in the feedback link message, not just the abstract error message. The feedback link gets used in a lot more contexts than this message.
…py to ensure the version is included in the error message, add test_constants.py to ensure BF_VERSION is not an empty string, add BF_VERSION to bigframes/constants.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds a variable to hold the user's bigframes version number and plugs it into the abstract method error message to be used in the feedback survey.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #843 🦕