Skip to content

Conversation

@Lumabots
Copy link
Contributor

@Lumabots Lumabots commented Dec 8, 2025

Summary

i do understand the point of this change, but at the same time i did it for 1 property but not the 1000 others

Information

  • This PR fixes an issue. discord.Member.voice is lacking documentation #3003
  • 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, typehinting,
    examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.
  • I have updated the changelog to include these changes.

The docstring for the Member.voice property now includes a detailed Returns section, clarifying the return type and behavior when the member is not in a voice channel.
@Lumabots Lumabots requested a review from a team as a code owner December 8, 2025 12:39
@pycord-app
Copy link

pycord-app bot commented Dec 8, 2025

Thanks for opening this pull request!
Please make sure you have read the Contributing Guidelines and Code of Conduct.

This pull request can be checked-out with:

git fetch origin pull/3023/head:pr-3023
git checkout pr-3023

This pull request can be installed with:

pip install git+https://github.com/Pycord-Development/pycord@refs/pull/3023/head

@Lumabots
Copy link
Contributor Author

Lumabots commented Dec 8, 2025

#3003

@property
def voice(self) -> VoiceState | None:
"""Returns the member's current voice state."""
"""Optional[:class:`VoiceState`]: Return the member's current voice state."""
Copy link
Member

@Paillat-dev Paillat-dev Dec 8, 2025

Choose a reason for hiding this comment

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

Suggested change
"""Optional[:class:`VoiceState`]: Return the member's current voice state."""
"""
Returns
-------
Optional[:class:`VoiceState`]:
The member's current voice state.
"""

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this breaks the docs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Screenshot 2025-12-09 at 09 59 52

@Lumabots Lumabots requested a review from Paillat-dev December 9, 2025 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants