Skip to content

fix: Improve docstring wording of 'for regular members'#3120

Open
Lee4test wants to merge 5 commits intoPycord-Development:masterfrom
Lee4test:fix-docstring-regular-members
Open

fix: Improve docstring wording of 'for regular members'#3120
Lee4test wants to merge 5 commits intoPycord-Development:masterfrom
Lee4test:fix-docstring-regular-members

Conversation

@Lee4test
Copy link

@Lee4test Lee4test commented Feb 22, 2026

Summary

This PR improves docstring wording by removing the phrase “For regular members.”
Closes #3117

Information

  • 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, 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.

@Lee4test Lee4test requested review from a team as code owners February 22, 2026 05:48
@pycord-app
Copy link

pycord-app bot commented Feb 22, 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/3120/head:pr-3120
git checkout pr-3120

This pull request can be installed with:

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

@Icebluewolf
Copy link
Member

Icebluewolf commented Feb 22, 2026

The start of a sentence should begin with a capital letter. The issue you are solving also references multiple other places that this need to be fixed.

As far as I know you should not be commiting changes to the docs folder, as it will be auto-generated when the PR is merged.

@Lee4test Lee4test force-pushed the fix-docstring-regular-members branch from 5286762 to 75cd298 Compare February 22, 2026 06:42
@Lee4test
Copy link
Author

Thank you for the review!

I've fixed the capitalization issue and removed the changes in the generated docs folder.
The fix has been applied only to discord/member.py.

Please let me know if anything else needs to be adjusted.

@ToothyDev
Copy link
Contributor

BaseUser.display_avatar also still uses this wording

@Lee4test Lee4test force-pushed the fix-docstring-regular-members branch from 75cd298 to d161e0e Compare February 23, 2026 00:41
@Lee4test
Copy link
Author

Thanks for pointing that out.
I've updated BaseUser.display_avatar as well.

@plun1331
Copy link
Member

@Lee4test is there a reason you keep force-pushing instead of just making a new commit?

@Lee4test
Copy link
Author

I was amending to keep the commit history clean, but I'm happy to add follow-up commits instead if that's preferred.

@ToothyDev
Copy link
Contributor

You don't have to do that in this repo, when the pull request is merged all commits will be squashed into one so you can make as many commits as you need

@Lee4test
Copy link
Author

Got it, thanks for the clarification!

@Paillat-dev
Copy link
Member

I am not sure if replacing "For regular members this" with just "This" makes it clearer.

Specifically, saying "This is just their x" and then contradicting ourselves right after seems weird. But maybe I'm overthinking this. @JustaSqu1d maybe you have an idea ?

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.

Improve docstring wording of "for regular members"

7 participants