Skip to content

Commit af78ca0

Browse files
committed
Implement file links into test docs
1 parent 805738f commit af78ca0

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

tests/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ outlines how the tests are laid such that all these edge cases are handled.
88

99
Many tests in the main `/tests` directory are generic-related object-related tests. These ensure basic functionality surrounding how the more-complex objects of the library are constructed and function.
1010

11-
| Test File | Purpose and Logic |
12-
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13-
| `test_account.py` | Ensures that an `Account` object is created properly and its dunder methods work as expected. |
14-
| `test_aes.py` | Ensures that `Aes` object initializes properly by checking known dynamic keys and hashes. |
15-
| `test_asset.py` | Ensures that the rules regulating `Asset` resizing are correct and that the asset reading functions function correctly. |
16-
| `test_beta.py` | Ensures that a user with the `beta` flag disabled on a `Client` cannot call beta methods. This validates that the beta flag decorator works as expected. |
17-
| `test_proxy.py` | Ensures that the `TransformerListProxy` class initializes properly, transforms to expected objects as needed, and has the same interface as a typical `py.List` would. |
18-
| `test_ratelimits.py` | Ensures that the library's handling of rate limits is correct, and related exceptions are raised as expected. |
19-
| `test_repr.py` | The library uses a dynamic decorator to create the `__repr__` dunder by taking advantage of the `__slots__` on a class. This test ensures that the dynamic function works as expected. |
20-
| `test_methods.py` | The handling of all the functions on the `Client` and `SyncClient` class. See Edge Cases below for more information. |
11+
| Test File | Purpose and Logic |
12+
| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13+
| [`test_account.py`](test_account.py) | Ensures that an `Account` object is created properly and its dunder methods work as expected. |
14+
| [`test_aes.py`](test_aes.py) | Ensures that `Aes` object initializes properly by checking known dynamic keys and hashes. |
15+
| [`test_asset.py`](test_asset.py) | Ensures that the rules regulating `Asset` resizing are correct and that the asset reading functions function correctly. |
16+
| [`test_beta.py`](test_beta.py) | Ensures that a user with the `beta` flag disabled on a `Client` cannot call beta methods. This validates that the beta flag decorator works as expected. |
17+
| [`test_proxy.py`](test_proxy.py) | Ensures that the `TransformerListProxy` class initializes properly, transforms to expected objects as needed, and has the same interface as a typical `py.List` would. |
18+
| [`test_ratelimits.py`](test_ratelimits.py) | Ensures that the library's handling of rate limits is correct, and related exceptions are raised as expected. |
19+
| [`test_repr.py`](test_repr.py) | The library uses a dynamic decorator to create the `__repr__` dunder by taking advantage of the `__slots__` on a class. This test ensures that the dynamic function works as expected. |
20+
| [`test_methods.py`](test_methods.py) | The handling of all the functions on the `Client` and `SyncClient` class. See Edge Cases below for more information. |
2121

2222
### Edge Case Library Tests
2323

@@ -29,7 +29,7 @@ defined on them.
2929

3030
##### Test Client Hybrid: `test_client_hybrid.py`
3131

32-
The tests define a custom `ClientHybrid` class (in `./client/test_client_hybrid.py`). This class wraps a `Client` to act as an intermediatory between a requested API call and the actual method. When an API call is requested, the `ClientHybrid` will call **both** the async `Client` version and the `SyncClient` version of the method. The results are then compared to ensure that they are the same.
32+
The tests define a custom `ClientHybrid` class in [`client/test_client_hybrid.py`](client/test_client_hybrid.py). This class wraps a `Client` to act as an intermediatory between a requested API call and the actual method. When an API call is requested, the `ClientHybrid` will call **both** the async `Client` version and the `SyncClient` version of the method. The results are then compared to ensure that they are the same.
3333

3434
Thus, all tests that make API calls will import and use the `ClientHybrid`.
3535

0 commit comments

Comments
 (0)