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

Feature/telegram/implementation #651

Merged
merged 2 commits into from
Oct 30, 2024
Merged

Conversation

alimaktabi
Copy link
Collaborator

@alimaktabi alimaktabi commented Oct 30, 2024

Summary by Sourcery

Enhance the Telegram bot messages by improving the formatting of the 'about' message and fixing the unit conversion for the maximum claim amount in the 'gastap_stats' message.

Bug Fixes:

  • Fix the display of the maximum claim amount in the 'gastap_stats' message by converting it to the correct unit using the chain's decimals.

Enhancements:

  • Improve the formatting of the 'about' message in the Telegram bot by adding escape characters to punctuation marks.

Copy link
Contributor

sourcery-ai bot commented Oct 30, 2024

Reviewer's Guide by Sourcery

This PR makes minor text formatting improvements to the About message and updates the GasTap stats display to show token amounts with proper decimal places and symbols.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated text formatting in the About message
  • Fixed escape characters for punctuation marks
  • Ensured consistent formatting of bullet points
telegram/messages/about.py
Enhanced token amount display in GasTap stats
  • Added decimal place conversion using chain decimals
  • Added chain symbol to the displayed amount
telegram/messages/gastap_stats.py

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@alimaktabi alimaktabi merged commit e31a610 into develop Oct 30, 2024
1 check passed
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 @alimaktabi - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@@ -10,7 +10,7 @@

{% for faucet in faucets %}
🔵 *{{ faucet.chain.chain_name }}*
Max Claim Amount: {{ faucet.max_claim_amount }}
Max Claim Amount: {{ faucet.max_claim_amount / (10 ** faucet.chain.decimals) }} {{ faucet.chain.symbol }}
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Consider moving the decimal calculation to the business logic layer rather than performing it in the template

Template files should focus on presentation. Computing the formatted amount before rendering would improve maintainability and make edge cases easier to handle.

Max Claim Amount: {{ faucet.formatted_max_claim_amount }} {{ faucet.chain.symbol }}

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.

1 participant