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: add detailed docstrings to properties of Item #2683

Merged
merged 1 commit into from
Dec 29, 2024

Conversation

Error44s
Copy link
Contributor

Summary

This pull request enhances the Item class by adding detailed and professional docstrings for its properties and methods. The added docstrings improve clarity, maintainability, and usability for developers working with the PyCord library.

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

@Error44s Error44s requested a review from a team as a code owner December 29, 2024 15:07
@pullapprove4 pullapprove4 bot requested a review from ChickenDevs December 29, 2024 15:07
@Dorukyum Dorukyum changed the title Add Detailed Docstrings to the Item Class for Improved Documentation docs: add detailed docstrings to properties of Item Dec 29, 2024
Copy link
Member

@Lulalaby Lulalaby left a comment

Choose a reason for hiding this comment

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

merging for now, might be redundant next year tho

@Lulalaby Lulalaby merged commit 6937df6 into Pycord-Development:master Dec 29, 2024
24 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants