Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix sphinx warnings and errors #2529

Draft
wants to merge 28 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ebf6f16
docs: fix `application_commands.rst`
JustaSqu1d Aug 12, 2024
44185dc
fix(sphinx): `autosectionlabel_prefix_document` to false
JustaSqu1d Aug 12, 2024
17a59e5
Merge branch 'master' into docs/sphinx-warns-and-errors
JustaSqu1d Aug 12, 2024
b4a2d77
fix(sphinx): suppress duplicate references
JustaSqu1d Aug 12, 2024
9242ab9
Merge branch 'docs/sphinx-warns-and-errors' of https://github.com/Jus…
JustaSqu1d Aug 12, 2024
00028db
style(pre-commit): auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 12, 2024
01329cd
fix(docs): duplicate label changelog.md
JustaSqu1d Aug 12, 2024
4bae53f
Merge branch 'docs/sphinx-warns-and-errors' of https://github.com/Jus…
JustaSqu1d Aug 12, 2024
c279992
Merge branch 'master' into docs/sphinx-warns-and-errors
JustaSqu1d Aug 12, 2024
2298c40
docs: fix old changelog duplicate labels
JustaSqu1d Aug 13, 2024
81d4de3
Merge branch 'docs/sphinx-warns-and-errors' of https://github.com/Jus…
JustaSqu1d Aug 13, 2024
f04850c
Merge branch 'master' into docs/sphinx-warns-and-errors
JustaSqu1d Aug 13, 2024
2d1fde1
style(pre-commit): auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 13, 2024
63a9f9a
fix(docs): gateway references
JustaSqu1d Aug 13, 2024
9d738fc
fix: gateway link
JustaSqu1d Aug 13, 2024
2b4cba2
revert: old changelog changes
JustaSqu1d Aug 13, 2024
7f13d61
style(pre-commit): auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 13, 2024
a558a42
docs: fix old changelog duplicate labels
JustaSqu1d Aug 13, 2024
125f1fd
Merge branch 'docs/sphinx-warns-and-errors' of https://github.com/Jus…
JustaSqu1d Aug 13, 2024
96eea89
chore(deps): add `typing-extensions`
JustaSqu1d Aug 13, 2024
f430f1e
Merge branch 'master' into docs/sphinx-warns-and-errors
Lulalaby Aug 13, 2024
dec1687
Merge branch 'master' into docs/sphinx-warns-and-errors
Lulalaby Aug 13, 2024
9ec6b75
Merge branch 'master' into docs/sphinx-warns-and-errors
Lulalaby Aug 16, 2024
4f4cd53
Merge branch 'master' into docs/sphinx-warns-and-errors
Lulalaby Aug 16, 2024
c7a39ce
Merge branch 'master' into docs/sphinx-warns-and-errors
JustaSqu1d Aug 17, 2024
d3514a9
Merge branch 'master' into docs/sphinx-warns-and-errors
Lulalaby Aug 17, 2024
3cfbeac
Merge branch 'master' into docs/sphinx-warns-and-errors
JustaSqu1d Aug 19, 2024
087c7e9
Merge branch 'master' into docs/sphinx-warns-and-errors
JustaSqu1d Sep 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 44 additions & 42 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Fix `Enum` options not setting the correct type when only one choice is available.
([#2577](https://github.com/Pycord-Development/pycord/pull/2577))

### Changed
### Changed <a id="changelog-changed-unreleased"></a>

- Renamed `cover` property of `ScheduledEvent` and `cover` argument of
`ScheduledEvent.edit` to `image`.
Expand Down Expand Up @@ -70,7 +70,7 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.6.0] - 2024-07-09

### Added
### Added <a id="changelog-added-2.6.0"></a>

- Added `banner` parameter to `ClientUser.edit`.
([#2396](https://github.com/Pycord-Development/pycord/pull/2396))
Expand Down Expand Up @@ -101,7 +101,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Added `MessageCall` information.
([#2488](https://github.com/Pycord-Development/pycord/pull/2488))

### Fixed
### Fixed <a id="changelog-fixed-2.6.0"></a>

- Fixed the type-hinting of `Member.move_to` and `Member.edit` to reflect actual
behavior. ([#2386](https://github.com/Pycord-Development/pycord/pull/2386))
Expand Down Expand Up @@ -141,7 +141,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Further fixed logic when fetching audit logs.
([#2492](https://github.com/Pycord-Development/pycord/pull/2492))

### Changed
### Changed <a id="changelog-changed-2.6.0"></a>

- Changed the type of `Guild.bitrate_limit` to `int`.
([#2387](https://github.com/Pycord-Development/pycord/pull/2387))
Expand All @@ -164,7 +164,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Changed the error message that appears when attempting to add a subcommand group to a
subcommand group. ([#2275](https://github.com/Pycord-Development/pycord/pull/2275))

### Removed
### Removed <a id="changelog-removed-2.6.0"></a>

- Removed the `delete_message_days` parameter from ban methods. Please use
`delete_message_seconds` instead.
Expand All @@ -177,7 +177,7 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.5.0] - 2024-03-02

### Added
### Added <a id="changelog-added-2.5.0"></a>

- Added method to start bot via async context manager.
([#1801](https://github.com/Pycord-Development/pycord/pull/1801))
Expand Down Expand Up @@ -267,7 +267,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Added audit log support for voice channel status.
([#2373](https://github.com/Pycord-Development/pycord/pull/2373))

### Changed
### Changed <a id="changelog-changed-2.5.0"></a>

- Changed default for all `name_localizations` and `description_localizations`
attributes from being `None` to being `MISSING`.
Expand Down Expand Up @@ -302,14 +302,14 @@ These changes are available on the `master` branch, but have not yet been releas
- `BridgeOption` must now be used for arguments in bridge commands.
([#2252](https://github.com/Pycord-Development/pycord/pull/2252))

### Removed
### Removed <a id="changelog-removed-2.5.0"></a>

- Removed `Client.once` in favour of `once` argument in `Client.listen`.
([#1957](https://github.com/Pycord-Development/pycord/pull/1957))
- Removed `Embed.Empty` in favour of `None`, and `EmbedProxy` in favour of individual
classes. ([#2063](https://github.com/Pycord-Development/pycord/pull/2063))

### Fixed
### Fixed <a id="changelog-fixed-2.5.0"></a>

- Fixed `AttributeError` caused by
[#1957](https://github.com/Pycord-Development/pycord/pull/1957) when using listeners
Expand Down Expand Up @@ -418,13 +418,13 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.4.1] - 2023-03-20

### Changed
### Changed <a id="changelog-changed-2.4.1"></a>

- Updated the values of the `Color.embed_background()` classmethod to correspond with
new theme colors in the app.
([#1931](https://github.com/Pycord-Development/pycord/pull/1931))

### Fixed
### Fixed <a id="changelog-fixed-2.4.1"></a>

- Fixed the type-hinting of `SlashCommandGroup.walk_commands()` to reflect actual
behavior. ([#1838](https://github.com/Pycord-Development/pycord/pull/1838))
Expand All @@ -437,7 +437,7 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.4.0] - 2023-02-10

### Added
### Added <a id="changelog-added-2.4.0"></a>

- Added new AutoMod trigger metadata properties `regex_patterns`, `allow_list`, and
`mention_total_limit`; and added the `mention_spam` trigger type.
Expand All @@ -464,7 +464,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Improved support for setting channel types & added new channel types for
`discord.Option`. ([#1883](https://github.com/Pycord-Development/pycord/pull/1883))

### Changed
### Changed <a id="changelog-changed-2.4.0"></a>

- Changed `EmbeddedActivity` values to update accordingly with the new activities.
([#1859](https://github.com/Pycord-Development/pycord/pull/1859))
Expand All @@ -474,7 +474,7 @@ These changes are available on the `master` branch, but have not yet been releas
- The `version_info.release_level` attribute has been reverted to its previous name,
`releaselevel`. ([#1920](https://github.com/Pycord-Development/pycord/pull/1920))

### Fixed
### Fixed <a id="changelog-fixed-2.4.0"></a>

- Fixed bugs in `Page.update_files` where file objects stored in memory were causing an
`AttributeError`, and `io.BytesIO` files didn't send properly more than once.
Expand All @@ -487,12 +487,14 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.3.3] - 2023-02-10

### Fixed <a id="changelog-fixed-2.3.3"></a>

- Fixed an unhandled `KeyError` exception when receiving GIF stickers, causing crashes.
([#1915](https://github.com/Pycord-Development/pycord/pull/1915))

## [2.3.2] - 2022-12-03

### Fixed
### Fixed <a id="changelog-fixed-2.3.2"></a>

- Fixed another `AttributeError` relating to the new `bridge_commands` attribute on
`ext.bridge.Bot`. ([#1815](https://github.com/Pycord-Development/pycord/pull/1815))
Expand All @@ -503,14 +505,14 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.3.1] - 2022-11-27

### Fixed
### Fixed <a id="changelog-fixed-2.3.1"></a>

- Fixed `AttributeError` relating to the new `bridge_commands` attribute on
`ext.bridge.Bot`. ([#1802](https://github.com/Pycord-Development/pycord/pull/1802))

## [2.3.0] - 2022-11-23

### Added
### Added <a id="changelog-added-2.3.0"></a>

- New brief Attribute to BridgeSlashCommand.
([#1676](https://github.com/Pycord-Development/pycord/pull/1676))
Expand All @@ -531,7 +533,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Updated `Guild.features` to include new and previously missing features.
([#1788](https://github.com/Pycord-Development/pycord/pull/1788))

### Fixed
### Fixed <a id="changelog-fixed-2.3.0"></a>

- Fix bridge.has_permissions.
([#1695](https://github.com/Pycord-Development/pycord/pull/1695))
Expand All @@ -541,7 +543,7 @@ These changes are available on the `master` branch, but have not yet been releas
([#1719](https://github.com/Pycord-Development/pycord/pull/1719) &
[#1723](https://github.com/Pycord-Development/pycord/pull/1723))

### Changed
### Changed <a id="changelog-changed-2.3.0"></a>

- `get_application_command()` type kwarg now defaults to `ApplicationCommand`, so all
command types can be retrieved by default.
Expand All @@ -550,27 +552,27 @@ These changes are available on the `master` branch, but have not yet been releas
([#1678](https://github.com/Pycord-Development/pycord/pull/1678))
-

### Removed
### Removed <a id="changelog-removed-2.3.0"></a>

- Removed the guild feature `PRIVATE_THREADS` due to paywall limitation removal.
([#1789](https://github.com/Pycord-Development/pycord/pull/1789))

## [2.2.2] - 2022-10-05

### Fixed
### Fixed <a id="changelog-fixed-2.2.2"></a>

- Fixed `parent` attribute of second-level subcommands being set to the base level
command instead of the direct parent.
([#1673](https://github.com/Pycord-Development/pycord/pull/1673))

## [2.2.1] - 2022-10-05

### Added
### Added <a id="changelog-added-2.2.1"></a>

- New `SlashCommand.qualified_id` attribute.
([#1672](https://github.com/Pycord-Development/pycord/pull/1672))

### Fixed
### Fixed <a id="changelog-fixed-2.2.1"></a>

- Fixed a `TypeError` in `ban()` methods related to the new `delete_message_seconds`
parameter. ([#1666](https://github.com/Pycord-Development/pycord/pull/1666))
Expand All @@ -581,7 +583,7 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.2.0] - 2022-10-02

### Added
### Added <a id="changelog-added-2.2.0"></a>

- New Guild Feature `INVITES_DISABLED`.
([#1613](https://github.com/Pycord-Development/pycord/pull/1613))
Expand All @@ -603,7 +605,7 @@ These changes are available on the `master` branch, but have not yet been releas
for `Interaction` objects.
([#1609](https://github.com/Pycord-Development/pycord/pull/1609))

### Deprecated
### Deprecated <a id="changelog-deprecated-2.2.0"></a>

- The `delete_message_days` parameter in ban methods is now deprecated. Please use
`delete_message_seconds` instead.
Expand All @@ -613,7 +615,7 @@ These changes are available on the `master` branch, but have not yet been releas
`edit_original_response` & `delete_original_response` methods instead.
([#1609](https://github.com/Pycord-Development/pycord/pull/1609))

### Fixed
### Fixed <a id="changelog-fixed-2.2.0"></a>

- Various fixes to ext.bridge groups.
([#1633](https://github.com/Pycord-Development/pycord/pull/1633) &
Expand All @@ -627,29 +629,29 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.1.3] - 2022-09-06

### Fixed
### Fixed <a id="changelog-fixed-2.1.3"></a>

- Fix TypeError in `process_application_commands`.
([#1622](https://github.com/Pycord-Development/pycord/pull/1622))

## [2.1.2] - 2022-09-06

### Fixed
### Fixed <a id="changelog-fixed-2.1.2"></a>

- Fix subcommands having MISSING cog attribute.
([#1594](https://github.com/Pycord-Development/pycord/pull/1594) &
[#1605](https://github.com/Pycord-Development/pycord/pull/1605))

## [2.1.1] - 2022-08-25

### Fixed
### Fixed <a id="changelog-fixed-2.1.1"></a>

- Bridge command detection in cogs.
([#1592](https://github.com/Pycord-Development/pycord/pull/1592))

## [2.1.0] - 2022-08-25

### Added
### Added <a id="changelog-added-2.1.0"></a>

- Support for add, sub, union, intersect, and inverse operations on classes inheriting
from `BaseFlags`. ([#1486](https://github.com/Pycord-Development/pycord/pull/1486))
Expand Down Expand Up @@ -680,7 +682,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Support for `InteractionMessage` via the `message` property of `View`.
([#1492](https://github.com/Pycord-Development/pycord/pull/1492))

### Changed
### Changed <a id="changelog-changed-2.1.0"></a>

- Use `slash_variant` and `ext_variant` attributes instead of
`get_application_command()` and `get_ext_command()` methods on `BridgeCommand`.
Expand All @@ -690,7 +692,7 @@ These changes are available on the `master` branch, but have not yet been releas
- `commands.has_permissions()` check now returns `True` in DM channels.
([#1577](https://github.com/Pycord-Development/pycord/pull/1577))

### Fixed
### Fixed <a id="changelog-fixed-2.1.0"></a>

- Fix `VoiceChannel`/`CategoryChannel` data being invalidated on `Option._invoke`.
([#1490](https://github.com/Pycord-Development/pycord/pull/1490))
Expand Down Expand Up @@ -736,21 +738,21 @@ These changes are available on the `master` branch, but have not yet been releas
- Fix required parameters validation error.
([#1589](https://github.com/Pycord-Development/pycord/pull/1589))

### Security
### Security <a id="changelog-security-2.1.0"></a>

- Improved fix for application-based bots without the bot scope
([#1584](https://github.com/Pycord-Development/pycord/pull/1584))

## [2.0.1] - 2022-08-16

### Security
### Security <a id="changelog-security-2.0.1"></a>

- Fix for application-based bots without the bot scope
([#1568](https://github.com/Pycord-Development/pycord/pull/1568))

## [2.0.0] - 2022-07-08

### Added
### Added <a id="changelog-added-2.0.0"></a>

- New `news` property on `TextChannel`.
([#1370](https://github.com/Pycord-Development/pycord/pull/1370))
Expand Down Expand Up @@ -782,7 +784,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Native timeout support for `Modal`.
([#1434](https://github.com/Pycord-Development/pycord/pull/1434))

### Changed
### Changed <a id="changelog-changed-2.0.0"></a>

- Updated to new sticker limit for premium guilds.
([#1420](https://github.com/Pycord-Development/pycord/pull/1420))
Expand All @@ -791,12 +793,12 @@ These changes are available on the `master` branch, but have not yet been releas
- Updated deprecated IDENTIFY packet connection properties.
([#1430](https://github.com/Pycord-Development/pycord/pull/1430))

### Removed
### Removed <a id="changelog-removed-2.0.0"></a>

- `Guild.region` attribute (Deprecated on API, VoiceChannel.rtc_region should be used
instead). ([#1429](https://github.com/Pycord-Development/pycord/pull/1429))

### Fixed
### Fixed <a id="changelog-fixed-2.0.0"></a>

- Change `guild_only` to `dm_permission` in application command `to_dict` method.
([#1368](https://github.com/Pycord-Development/pycord/pull/1368))
Expand Down Expand Up @@ -839,7 +841,7 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.0.0-rc.1] - 2022-05-17

### Added
### Added <a id="changelog-added-2.0.0-rc.1"></a>

- A `delete_after` kwarg to `Paginator.send`.
([#1245](https://github.com/Pycord-Development/pycord/pull/1245))
Expand Down Expand Up @@ -889,7 +891,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Support event covers for audit logs.
([#1355](https://github.com/Pycord-Development/pycord/pull/1355))

### Changed
### Changed <a id="changelog-changed-2.0.0-rc.1"></a>

- Removed implicit defer call in `View`.
([#1260](https://github.com/Pycord-Development/pycord/pull/1260))
Expand All @@ -902,7 +904,7 @@ These changes are available on the `master` branch, but have not yet been releas
- Renamed `delete_exiting` to `delete_existing` (typo).
([#1336](https://github.com/Pycord-Development/pycord/pull/1336))

### Fixed
### Fixed <a id="changelog-fixed-2.0.0-rc.1"></a>

- Fix `PartialMessage.edit()` setting `view` as `None` when `view` kwarg is not passed.
([#1256](https://github.com/Pycord-Development/pycord/pull/1256))
Expand Down Expand Up @@ -939,7 +941,7 @@ These changes are available on the `master` branch, but have not yet been releas

## [2.0.0-beta.7] - 2022-04-09

### Fixed
### Fixed <a id="changelog-fixed-2.0.0-beta.7"></a>

- Fix py3.10 UnionType checks issue.
([#1240](https://github.com/Pycord-Development/pycord/pull/1240))
Expand Down
4 changes: 2 additions & 2 deletions discord/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1230,7 +1230,7 @@ def add_listener(self, func: Coro, name: str = MISSING) -> None:
TypeError
The ``func`` parameter is not a coroutine function.
ValueError
The ``name`` (event name) does not start with 'on_'
The ``name`` (event name) does not start with ``on_``

Example
-------
Expand Down Expand Up @@ -1294,7 +1294,7 @@ def listen(self, name: str = MISSING, once: bool = False) -> Callable[[Coro], Co
TypeError
The function being listened to is not a coroutine.
ValueError
The ``name`` (event name) does not start with 'on_'
The ``name`` (event name) does not start with ``on_``

Example
-------
Expand Down
Loading