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: guild.owner_id type mismatch between docs and code #1273

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nerd-bear
Copy link
Contributor

@nerd-bear nerd-bear commented Jan 17, 2025

Summary

Guild.owner_id documented as int, but is Optional[int] in code. Here are the links:
https://docs.disnake.dev/en/stable/api/guilds.html#disnake.Guild.owner_id
disnake/disnake/guild.py
disnake/disnake/guild.py

Checklist

  • If code changes were made, then they have been tested
    • I have updated the documentation to reflect the changes
    • I have formatted the code properly by running pdm lint
    • I have type-checked the code by running pdm pyright
  • This PR fixes an issue
  • This PR adds something new (e.g. new method or parameters)
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

Signed-off-by: Nerd Bear <[email protected]>
@shiftinv shiftinv added t: documentation Improvements or additions to documentation/examples skip news labels Jan 17, 2025
@@ -177,7 +177,7 @@ class Guild(Hashable):
The channel that denotes the AFK channel. ``None`` if it doesn't exist.
id: :class:`int`
The guild's ID.
owner_id: :class:`int`
owner_id: :class:`Optional[int]`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
owner_id: :class:`Optional[int]`
owner_id: Optional[:class:`int`]

Optional needs to wrap the :class:, otherwise intersphinx unfortunately can't find it

@@ -177,7 +177,7 @@ class Guild(Hashable):
The channel that denotes the AFK channel. ``None`` if it doesn't exist.
id: :class:`int`
The guild's ID.
owner_id: :class:`int`
owner_id: :class:`Optional[int]`
The guild owner's ID. Use :attr:`Guild.owner` if you need a :class:`Member` object instead.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A small note explaining why/when this can be None could be helpful:

Suggested change
The guild owner's ID. Use :attr:`Guild.owner` if you need a :class:`Member` object instead.
The guild owner's ID. Use :attr:`Guild.owner` if you need a :class:`Member` object instead.
This may be ``None`` if the guild is :attr:`~Guild.unavailable`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip news t: documentation Improvements or additions to documentation/examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants