-
Notifications
You must be signed in to change notification settings - Fork 185
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: redo events guide #1474
Merged
LordOfPolls
merged 5 commits into
interactions-py:unstable
from
AstreaTSS:event-guide-update
Jul 10, 2023
Merged
docs: redo events guide #1474
LordOfPolls
merged 5 commits into
interactions-py:unstable
from
AstreaTSS:event-guide-update
Jul 10, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Marking as ready to review. |
silasary
approved these changes
Jul 7, 2023
LordOfPolls
requested changes
Jul 7, 2023
Most changes that were requested have been accounted for, but I put my two cents for the two final ones. |
Added back example usage in the API reference as discussed in Poll's review. |
LordOfPolls
approved these changes
Jul 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Type
Description
This PR aims to redo the events guide, which has been a pain point for a large amount of users. The guide itself is too short, uses unclear language, and does not give proper warnings about what not to do.
This PR does not give a whole list of events, nor is there intention to. It is to my belief that lists of events already exist in the API documentation - I believe adding more information about how events work will outset the need to create a redundant list that will need constant updating. However, if enough people disagree, I can add it in.
Changes
This is largely a "see the diff" PR. That being said...
Related Issues
Test Scenarios
Python Compatibility
3.10.x
3.11.x
Checklist
pre-commit
code linter over all edited files