Skip to content

Conversation

@MonaaEid
Copy link
Contributor

@MonaaEid MonaaEid commented Dec 9, 2025

Description
This pull request introduces comprehensive training documentation for the _Executable class, aimed at SDK developers.

  • The documentation explains the core execution flow, retry logic, error handling, logging, and debugging strategies for transactions and queries in the Hedera SDK.

  • This addition is intended to help both new and existing contributors understand and troubleshoot the SDK's execution engine more effectively.

Documentation Additions:

  • Added a detailed training guide for the _Executable class in docs/sdk_developers/training/executable.md, covering execution flow, retry logic with exponential backoff, error handling, logging, debugging tips, and practical usage examples.
  • Updated CHANGELOG.md to include the addition of the comprehensive _Executable class training documentation.Description:

Related issue(s):

Fixes #909

Checklist

  • Updated CHANGELOG.md
  • Documented

@MonaaEid MonaaEid marked this pull request as ready for review December 9, 2025 22:46
Copilot AI review requested due to automatic review settings December 9, 2025 22:46
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request introduces comprehensive training documentation for the _Executable class, which serves as the core execution engine for the Hedera SDK. The documentation is designed to help SDK developers understand the internal workings of transaction and query execution, including retry logic, error handling, and debugging strategies.

  • Added a detailed 346-line training guide covering execution flow, retry mechanisms with exponential backoff, error handling patterns, logging strategies, and debugging workflows
  • Included Mermaid diagrams, code examples, and practical debugging checklists
  • Updated CHANGELOG.md to document this new training resource

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 20 comments.

File Description
docs/sdk_developers/training/executable.md Comprehensive training guide for the _Executable class with sections on execution flow, retry logic, error handling, logging, and debugging techniques
CHANGELOG.md Added changelog entry documenting the new training documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@MonaaEid
Copy link
Contributor Author

MonaaEid commented Dec 9, 2025

@exploreriii please review when you have time.

@MonaaEid MonaaEid marked this pull request as draft December 9, 2025 22:58
@MonaaEid MonaaEid marked this pull request as ready for review December 10, 2025 01:18
@exploreriii
Copy link
Contributor

Request review @manishdait @tech0priyanshu if possible

Copy link
Contributor

@manishdait manishdait left a comment

Choose a reason for hiding this comment

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

Hi @MonaaEid, Some changes needed for the proper formatting of the code blocks.

@tech0priyanshu
Copy link
Contributor

@MonaaEid Everything looks good. You already have a comprehensive review from @manishdait and Copilot.
Just a suggestion you can convert this to a draft PR until another review is needed.

@exploreriii exploreriii marked this pull request as draft December 10, 2025 11:27
@MonaaEid MonaaEid force-pushed the docs/909-executable-crash-course branch from 6915b88 to a6f64b7 Compare December 10, 2025 13:23
@github-actions
Copy link

[commit-verification-bot]
Hi, this is VerificationBot.
Your pull request cannot be merged as it has unverified commits.
View your commit verification status: Commits Tab.

To achieve verified status, please read:

Remember, you require a GPG key and each commit must be signed with:
git commit -S -s -m "Your message here"

Thank you for contributing!

From the Hiero Python SDK Team

@MonaaEid MonaaEid force-pushed the docs/909-executable-crash-course branch 4 times, most recently from df62561 to 18063a3 Compare December 10, 2025 13:54
Signed-off-by: MonaaEid <monaa_eid@hotmail.com>
@MonaaEid MonaaEid force-pushed the docs/909-executable-crash-course branch from 18063a3 to 25f0c65 Compare December 10, 2025 13:59
@MonaaEid MonaaEid requested a review from manishdait December 10, 2025 14:06
@MonaaEid MonaaEid marked this pull request as ready for review December 10, 2025 18:19
@exploreriii exploreriii merged commit f9b33d9 into hiero-ledger:main Dec 11, 2025
14 checks passed
@exploreriii
Copy link
Contributor

Thank you @MonaaEid @tech0priyanshu and @manishdait !
Excellent PR and great contribution

@MonaaEid MonaaEid deleted the docs/909-executable-crash-course branch December 11, 2025 14:12
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.

Create docs/sdk_developers/training/executable.md

4 participants