Skip to content

Commit 080b05d

Browse files
authored
docs: fix documentation relative links and normalize test file naming (hiero-ledger#1730)
Signed-off-by: achahid19 <anasks1999@gmail.com>
1 parent 8b0c4f4 commit 080b05d

3 files changed

Lines changed: 8 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
152152
- Type hints to exception classes (`PrecheckError`, `MaxAttemptsError`, `ReceiptStatusError`) constructors and string methods.
153153

154154
### Documentation
155+
- Fix relative links in `testing.md`, clean up `CONTRIBUTING.md` TOC, and normalize test file naming and paths (`#1706`)
155156
- Added comprehensive docstring to `compress_with_cryptography` function (#1626)
156157
- Replaced the docstring in `entity_id_helper.py` with one that is correct. (#1623)
157158

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ Thank you for your interest in contributing to the Hiero Python SDK!
1010
- [Feature Requests](#-feature-requests)
1111
- [Blog Posts](#-blog-posts)
1212
- [Developer Resources](#developer-resources)
13-
- [Community & Support](#community--support)
1413
- [Cheatsheet](#cheatsheet)
15-
- [Common Issues](#common-issues)
1614

1715
---
1816

docs/sdk_developers/testing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -445,14 +445,14 @@ Let's walk through creating both unit and integration tests for a hypothetical n
445445

446446
**File:**
447447
You may look at an already-created unit test file for better clarity:
448-
[test_token_pause_transaction.py](tests\unit\test_token_pause_transaction.py)
448+
[token_pause_transaction_test.py](../../tests/unit/token_pause_transaction_test.py)
449449

450450

451451
#### 2. Create Integration Test
452452

453453
**File:**
454454
You may look at an already-created unit test file for better clarity:
455-
[token_pause_transaction_e2e_test.py](tests\integration\token_pause_transaction_e2e_test.py)
455+
[token_pause_transaction_e2e_test.py](../../tests/integration/token_pause_transaction_e2e_test.py)
456456

457457
#### 3. Run Your Tests
458458

@@ -1140,11 +1140,11 @@ Before submitting a pull request, ensure:
11401140

11411141
### Simple Unit Test Example
11421142

1143-
**File:** [test_account_id.py](tests\unit\test_account_id.py)
1143+
**File:** [account_id_test.py](../../tests/unit/account_id_test.py)
11441144

11451145
### Simple Integration Test Example
11461146

1147-
**File:** [account_balance_query_e2e_test.py](tests\integration\account_balance_query_e2e_test.py)
1147+
**File:** [account_balance_query_e2e_test.py](../../tests/integration/account_balance_query_e2e_test.py)
11481148

11491149
### Complex Integration Test Example
11501150

@@ -1195,14 +1195,14 @@ If you encounter issues or have questions:
11951195

11961196
1. **Check this guide** - Most common scenarios are covered
11971197
2. **Review existing tests** - Look at similar tests in the codebase
1198-
3. **Check documentation** - See `/docs/sdk_developers/`
1198+
3. **Check documentation** - See [`/docs/sdk_developers/`](./)
11991199
4. **Ask in Discord** - Ask on the [Linux Foundation Decentralized Trust Discord](https://discord.gg/hyperledger)
12001200
5. **Open an issue** - For bugs or unclear documentation
12011201

12021202
### Useful Resources
12031203

1204-
- **Contributing Guide**: [CONTRIBUTING.md](CONTRIBUTING.md)
1205-
- **Commit Signing Guide**: [docs/sdk_developers/signing.md](docs\sdk_developers\signing.md)
1204+
- **Contributing Guide**: [CONTRIBUTING.md](../../CONTRIBUTING.md)
1205+
- **Commit Signing Guide**: [signing.md](signing.md)
12061206
- **pytest Documentation**: https://docs.pytest.org/
12071207
- **Hedera Documentation**: https://docs.hedera.com/
12081208
- **Hiero Solo**: https://github.com/hiero-ledger/solo

0 commit comments

Comments
 (0)