Skip to content

Commit ba5f157

Browse files
committed
Adjusted documentation with new exception names
1 parent 35aaaad commit ba5f157

3 files changed

Lines changed: 44 additions & 3 deletions

File tree

docs/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ Usage guide
2929
Migration guide
3030
---------------
3131

32-
If you are still using version 3.x or lower, it is highly recommended upgrading to the latest version.
32+
If you are still using version 4.x or lower, it is highly recommended upgrading to the latest version.
3333

3434
.. toctree::
3535
:maxdepth: 1
3636

37-
./pages/migration-guide.md
37+
./pages/migration-guide-4.md
38+
./pages/migration-guide-5.md
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Migration guide
1+
# Migration guide from 3.x to 4.x
22

33
This guide explains how to proceed with the migration from version 3.x to version 4.x of your current code.
44
If you are still using the old version, it is highly recommended to update, since you wont get any future

docs/pages/migration-guide-5.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Migration guide from 4.x to 5.x
2+
3+
This guide explains how to proceed with the migration from version 4.x to version 5.x of your current code.
4+
If you are still using the old version, it is highly recommended to update, since you wont get any future
5+
updates nor new features.
6+
7+
## Changelog summary
8+
9+
- Updated custom exceptions names.
10+
11+
## How to upgrade?
12+
13+
Upgrading to the last version of this module is as easy as running this pip command:
14+
15+
pip install python-amazon-paapi --upgrade
16+
17+
## What should I change in my current code?
18+
19+
### Exceptions
20+
21+
Exceptions names have changed, removing the `Exception` part of the name or replacing it
22+
with `Error`. They should be adjusted as bellow:
23+
24+
```python
25+
AmazonException -> AmazonError
26+
AsinNotFoundException -> AsinNotFound
27+
AssociateValidationException -> AssociateValidationError
28+
InvalidArgumentException -> InvalidArgument
29+
InvalidPartnerTagException -> InvalidPartnerTag
30+
ItemsNotFoundException -> ItemsNotFound
31+
MalformedRequestException -> MalformedRequest
32+
ApiRequestException -> RequestError
33+
TooManyRequestsException -> TooManyRequests
34+
```
35+
36+
### I need more help
37+
38+
You can always ask for help in our [Telegram group](https://t.me/PythonAmazonPAAPI) or raise an issue on
39+
[Github](https://github.com/sergioteula/python-amazon-paapi/issues) for help. If you find that this
40+
guide could be improved somehow, feel free to send a pull request with your changes.

0 commit comments

Comments
 (0)