Skip to content

docs: improve docstring wording for display properties#3163

Closed
Sim-hu wants to merge 1 commit intoPycord-Development:masterfrom
Sim-hu:fix/improve-docstring-wording
Closed

docs: improve docstring wording for display properties#3163
Sim-hu wants to merge 1 commit intoPycord-Development:masterfrom
Sim-hu:fix/improve-docstring-wording

Conversation

@Sim-hu
Copy link

@Sim-hu Sim-hu commented Mar 21, 2026

Replaces the awkward "for regular members" / "for regular users" phrasing in
display_avatar, display_avatar_decoration, display_banner (in Member),
and display_avatar (in User) with clearer descriptions of the
guild-specific fallback behavior.

The original wording ("for regular members this is just their avatar, but...")
reads a bit oddly and implies the existence of "irregular" members. The updated
docstrings now directly describe what the property returns depending on whether
a guild-specific override is set.

Closes #3117

…nd display_avatar_decoration

Replace awkward "for regular members/users" phrasing with clearer
descriptions of the guild-specific fallback behavior.

Closes #3117
@Sim-hu Sim-hu requested a review from a team as a code owner March 21, 2026 07:36
@github-project-automation github-project-automation bot moved this to Todo in Pycord Mar 21, 2026
@pycord-app
Copy link

pycord-app bot commented Mar 21, 2026

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/3163/head:pr-3163
git checkout pr-3163

This pull request can be installed with:

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

Copy link
Member

@Paillat-dev Paillat-dev left a comment

Choose a reason for hiding this comment

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

  1. This is a redo of #3120. Please see the comments there.
  2. Please follow the pull request template and disclose LLM Usage.

@Sim-hu
Copy link
Author

Sim-hu commented Mar 21, 2026

Sorry about that, I missed the PR template and didn't realize #3120 was already working on this. Closing in favor of that one.

@Sim-hu Sim-hu closed this Mar 21, 2026
@github-project-automation github-project-automation bot moved this from Todo to Done in Pycord Mar 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Improve docstring wording of "for regular members"

2 participants