Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@Ali-Toosi
Copy link
Contributor

@Ali-Toosi Ali-Toosi commented Sep 3, 2025

The code docs for talker.handle incorrectly show the error message argument before the stack trace. This PR fixes that.

Summary by Sourcery

Fix parameter order in talker.handle documentation to place the stack trace argument before the error message

Documentation:

  • Update talker.handle doc comments to swap the order of the stackTrace and msg parameters
  • Correct the code example to call talker.handle(e, st, 'Exception in ...') instead of talker.handle(e, 'Exception in ...', st)

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 3, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updated documentation for talker.handle to reflect correct parameter order, placing stack trace before message.

Class diagram for updated talker.handle documentation

classDiagram
class Talker {
  +handle(Object exception, StackTrace? stackTrace, String? msg)
}
Loading

File-Level Changes

Change Details Files
Corrected parameter order in talker.handle docs and examples
  • Swapped doc comment lines to list stackTrace before msg
  • Updated code example to pass stackTrace before message in talker.handle invocation
packages/talker/lib/src/talker.dart

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click πŸ‘ or πŸ‘Ž on each comment and I'll use the feedback to improve your reviews.

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

βœ… All modified and coverable lines are covered by tests.
βœ… Project coverage is 90.97%. Comparing base (1ed15ab) to head (4ccf40b).
⚠️ Report is 95 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #420      +/-   ##
==========================================
- Coverage   98.63%   90.97%   -7.66%     
==========================================
  Files           3       13      +10     
  Lines         146      266     +120     
==========================================
+ Hits          144      242      +98     
- Misses          2       24      +22     

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

πŸš€ New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Frezyx
Copy link
Owner

Frezyx commented Sep 3, 2025

Hello @Ali-Toosi !
Thank you for this contribution ❀️

@Frezyx Frezyx merged commit 8e1a8d9 into Frezyx:master Sep 3, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants