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

Slightly adjust exception output text #1547

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

neiljp
Copy link
Collaborator

@neiljp neiljp commented Oct 3, 2024

What does this PR do, and why?

This minor change ties together the older (file) and newer (hotkey) methods of obtaining the exception traceback, with some motivational text to include them in bug reports.

External discussion & connections

  • Discussed in #zulip-terminal in topic
  • Fully fixes #
  • Partially fixes issue #
  • Builds upon previous unmerged work in PR #
  • Is a follow-up to work in PR Copy traceback from the Exception popup #1513
  • Requires merge of PR #
  • Merge will enable work on #

How did you test this?

  • Manually - Behavioral changes
  • Manually - Visual changes
  • Adapting existing automated tests
  • Adding automated tests for new behavior (or missing tests)
  • Existing automated tests should already cover this (only a refactor of tested code)

Self-review checklist for each commit

  • It is a minimal coherent idea
  • It has a commit summary following the documented style (title & body)
  • It has a commit summary describing the motivation and reasoning for the change
  • It individually passes linting and tests
  • It contains test additions for any new behavior
  • It flows clearly from a previous branch commit, and/or prepares for the next commit

neiljp added 2 commits October 3, 2024 15:04
The exception details and traceback are made available in the popup, but
it may be unclear why this would be necessary until later, so this
adjusts the text to motivate capturing this information when reporting a
bug or issue.
@neiljp neiljp added the enhancement New feature or request label Oct 3, 2024
@zulipbot zulipbot added the size: M [Automatic label added by zulipbot] label Oct 3, 2024
@neiljp
Copy link
Collaborator Author

neiljp commented Oct 3, 2024

@rsashank This was the small change I was referring to, at least the rewording - helpful?

@rsashank
Copy link
Member

rsashank commented Oct 4, 2024

@rsashank This was the small change I was referring to, at least the rewording - helpful?

Yes, this looks good! I wasn't sure how to phrase it, so I couldn't make the change myself. Thanks for helping with that.

@neiljp neiljp merged commit dc4d9bc into zulip:main Oct 4, 2024
21 checks passed
@neiljp neiljp added this to the Next Release milestone Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request size: M [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants