-
Notifications
You must be signed in to change notification settings - Fork 107
feat: add comprehensive training documentation for _Executable class
#1024
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
feat: add comprehensive training documentation for _Executable class
#1024
Conversation
There was a problem hiding this 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.
|
@exploreriii please review when you have time. |
|
Request review @manishdait @tech0priyanshu if possible |
manishdait
left a comment
There was a problem hiding this 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.
|
@MonaaEid Everything looks good. You already have a comprehensive review from @manishdait and Copilot. |
6915b88 to
a6f64b7
Compare
|
[commit-verification-bot] To achieve verified status, please read: Remember, you require a GPG key and each commit must be signed with: Thank you for contributing! From the Hiero Python SDK Team |
df62561 to
18063a3
Compare
Signed-off-by: MonaaEid <monaa_eid@hotmail.com>
18063a3 to
25f0c65
Compare
Signed-off-by: MontyPokemon <59332150+MonaaEid@users.noreply.github.com>
|
Thank you @MonaaEid @tech0priyanshu and @manishdait ! |
Description
This pull request introduces comprehensive training documentation for the
_Executableclass, 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:
_Executableclass indocs/sdk_developers/training/executable.md, covering execution flow, retry logic with exponential backoff, error handling, logging, debugging tips, and practical usage examples.CHANGELOG.mdto include the addition of the comprehensive_Executableclass training documentation.Description:Related issue(s):
Fixes #909
Checklist