Skip to content

docs: fix incorrect test file examples in testing guide#2270

Merged
manishdait merged 1 commit into
hiero-ledger:mainfrom
ZainabTravadi:docs/fix-testing-guide-examples-clean
May 13, 2026
Merged

docs: fix incorrect test file examples in testing guide#2270
manishdait merged 1 commit into
hiero-ledger:mainfrom
ZainabTravadi:docs/fix-testing-guide-examples-clean

Conversation

@ZainabTravadi

Copy link
Copy Markdown
Contributor

Fix stale/incorrect test file examples in the developer testing guide.

Changes:

  • update outdated unit test filename example to match the repository _test.py naming convention
  • correct integration test example path to reference the existing repository file
  • add a lightweight regression test verifying the documented examples reference real repository files

Fixes #2269

Notes for reviewer:

This is a small documentation correctness fix intended to keep contributor-facing testing examples aligned with the current repository structure.

Copilot AI review requested due to automatic review settings May 12, 2026 17:08
@ZainabTravadi
ZainabTravadi requested review from a team as code owners May 12, 2026 17:08
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity

Metric Results
Complexity 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 078cb072-dc01-419a-86d3-a52700963b26

📥 Commits

Reviewing files that changed from the base of the PR and between f111c93 and d2e20cd.

📒 Files selected for processing (1)
  • docs/sdk_developers/testing.md

Walkthrough

This PR corrects two stale test file name examples in the SDK testing documentation. The unit-test directory example now references the correct _test.py naming convention, and the integration test command path is updated to match the actual repository file.

Changes

Testing Documentation Corrections

Layer / File(s) Summary
Test example file references
docs/sdk_developers/testing.md
Updated unit-test directory structure example from test_account_create_transaction.py to account_create_transaction_test.py, and integration test command from token_transfer_e2e_test.py to transfer_transaction_e2e_test.py to match actual repository files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: fixing incorrect test file examples in the testing documentation.
Description check ✅ Passed The description is relevant and provides specific context about the changes, including the outdated examples being fixed and references the linked issue.
Linked Issues check ✅ Passed The PR addresses all key requirements from issue #2269: updates unit test filename examples to match _test.py convention, corrects integration test file path, and includes regression testing.
Out of Scope Changes check ✅ Passed All changes in the PR are directly related to fixing stale test file examples and adding regression tests as outlined in the linked issue, with no extraneous modifications.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: e40baa94-b762-41c6-a377-5bcd52c2503e

📥 Commits

Reviewing files that changed from the base of the PR and between 5345fd5 and f111c93.

📒 Files selected for processing (2)
  • docs/sdk_developers/testing.md
  • tests/unit/testing_guide_examples_test.py

Comment thread tests/unit/testing_guide_examples_test.py Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes stale file/path examples in the developer testing guide so that the documented unit/integration test commands and example filenames match the repository’s current test layout, and adds a small unit test to prevent the docs from drifting again.

Changes:

  • Update the unit test filename example in docs/sdk_developers/testing.md to use the repository’s *_test.py naming.
  • Correct the integration test command example to reference an existing integration test file.
  • Add a unit test that asserts the documented example filenames/paths exist in the repo.

Reviewed changes

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

File Description
docs/sdk_developers/testing.md Fixes the documented unit/integration test example filenames/paths to match real repository files.
tests/unit/testing_guide_examples_test.py Adds a regression test that validates the docs reference existing test files.

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

@github-actions github-actions Bot added open to community review PR is open for community review and feedback queue:junior-committer PR awaiting initial quality review labels May 12, 2026
Comment thread tests/unit/testing_guide_examples_test.py Outdated
Signed-off-by: Zainab Travadi <zainabtravadi421@gmail.com>
@ZainabTravadi
ZainabTravadi force-pushed the docs/fix-testing-guide-examples-clean branch from f111c93 to d2e20cd Compare May 13, 2026 09:32

@exploreriii exploreriii left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you for spotting and resolving this

@github-actions github-actions Bot added Good First Issue Issues which are ideal for a first time or new project contributor. scope: docs involves documentation labels May 13, 2026
@manishdait manishdait added this to the v0.2.7 milestone May 13, 2026
@manishdait
manishdait merged commit 0ce2755 into hiero-ledger:main May 13, 2026
10 checks passed
@github-actions

Copy link
Copy Markdown

👋 Hi @ZainabTravadi! Great work completing a Good First Issue issue! 🎉

Thanks for your contribution! 🚀

Here are some issues you might want to explore next:

🌟 Stay connected:

Happy coding! 🚀
— Hiero Python SDK Team

NssGourav pushed a commit to NssGourav/hiero-sdk-python that referenced this pull request May 14, 2026
…#2270)

Signed-off-by: Zainab Travadi <zainabtravadi421@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Good First Issue Issues which are ideal for a first time or new project contributor. open to community review PR is open for community review and feedback queue:junior-committer PR awaiting initial quality review scope: docs involves documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect test file examples in developer testing guide

5 participants