Skip to content

Commit 29604f3

Browse files
committed
Documentation fixes
1 parent 6905a15 commit 29604f3

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

tests/resources/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,15 @@ nonexistent world or a unselected world.
134134

135135
## Events resources
136136
- [tibiacom_calendar.txt](events/tibiacom_calendar.txt) - The content of the event's calendar.
137+
138+
## Bazaar resources
139+
- [tibiacom_auction_finished.txt](bazaar/tibiacom_auction_finished.txt) - The content of a finished auction.
140+
- [tibiacom_auction_not_found.txt](bazaar/tibiacom_auction_not_found.txt) - The content of an auction that doesn't exist.
141+
- [tibiacom_current.txt](bazaar/tibiacom_current.txt) - The content of the current auctions page.
142+
- [tibiacom_current_all_filters.txt](bazaar/tibiacom_current_all_filters.txt) - The content of the current auctions page with all filters selected.
143+
- [tibiacom_history.txt](bazaar/tibiacom_history.txt) - The content of the auction history page.
144+
- [tibiacom_history_empty.txt](bazaar/tibiacom_history_empty.txt) - The content of the auction history page with no entries.
145+
137146

138147
## Other resources
139148
- [tibiacom_about.txt](tibiacom_about.txt) - The 'About Tibia' section on Tibia.com, used to provide invalid content

tibiapy/abc.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ class BaseAnnouncement(metaclass=abc.ABCMeta):
9393
9494
The following implement this class:
9595
96-
- :class:`ForumAnnouncement`
97-
- :class:`ListedAnnouncement`
96+
- :class:`.ForumAnnouncement`
97+
- :class:`.ListedAnnouncement`
9898
9999
Attributes
100100
----------
@@ -138,8 +138,8 @@ class BaseBoard(metaclass=abc.ABCMeta):
138138
139139
The following implement this class:
140140
141-
- :class:`ForumBoard`
142-
- :class:`ListedBoard`
141+
- :class:`.ForumBoard`
142+
- :class:`.ListedBoard`
143143
144144
Attributes
145145
----------
@@ -242,6 +242,8 @@ class BaseCharacter(metaclass=abc.ABCMeta):
242242
- :class:`.LeaderboardEntry`
243243
- :class:`.OnlineCharacter`
244244
- :class:`.OtherCharacter`
245+
- :class:`.ListedAuction`
246+
- :class:`.AuctionDetails`
245247
246248
Attributes
247249
----------
@@ -509,9 +511,9 @@ class BasePost(metaclass=abc.ABCMeta):
509511
510512
The following implement this class:
511513
512-
- :class:`CMPost`
513-
- :class:`ForumPost`
514-
- :class:`LastPost`
514+
- :class:`.CMPost`
515+
- :class:`.ForumPost`
516+
- :class:`.LastPost`
515517
516518
Attributes
517519
----------

tibiapy/errors.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def __init__(self, message, original=None):
3737

3838

3939
class Forbidden(NetworkError):
40-
"""A subclass of network error thrown when Tibia.com returns a 403 status code.
40+
"""A subclass of :class:`NetworkError` thrown when Tibia.com returns a 403 status code.
4141
4242
Tibia.com returns a 403 status code when it detects that too many requests are being done.
4343
This has its own subclass to let the user decide to treat this differently than other network errors.

0 commit comments

Comments
 (0)