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: redo events guide #1474

Merged
merged 5 commits into from
Jul 10, 2023

Conversation

AstreaTSS
Copy link
Member

@AstreaTSS AstreaTSS commented Jul 6, 2023

Pull Request Type

  • Feature addition
  • Bugfix
  • Documentation update
  • Code refactor
  • Tests improvement
  • CI/CD pipeline enhancement
  • Other: [Replace with a description]

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

  • Completely revamp the events guide. It attempts to mitigate some pain points that people mentioned during feedback, and clarifies on other sections that could use it.
  • Remove the name disclaimer from the two event API Reference pages.

Related Issues

Test Scenarios

Python Compatibility

  • I've ensured my code works on Python 3.10.x
  • I've ensured my code works on Python 3.11.x

Checklist

  • I've run the pre-commit code linter over all edited files
  • I've tested my changes on supported Python versions
  • I've added tests for my code, if applicable
  • I've updated / added documentation, where applicable

@AstreaTSS AstreaTSS marked this pull request as ready for review July 6, 2023 23:22
@AstreaTSS
Copy link
Member Author

Marking as ready to review.

docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
docs/src/Guides/10 Events.md Outdated Show resolved Hide resolved
interactions/api/events/discord.py Outdated Show resolved Hide resolved
interactions/api/events/internal.py Outdated Show resolved Hide resolved
@AstreaTSS
Copy link
Member Author

Most changes that were requested have been accounted for, but I put my two cents for the two final ones.

@AstreaTSS
Copy link
Member Author

Added back example usage in the API reference as discussed in Poll's review.

@LordOfPolls LordOfPolls merged commit c66fde3 into interactions-py:unstable Jul 10, 2023
1 check passed
@AstreaTSS AstreaTSS deleted the event-guide-update branch July 10, 2023 14:27
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.

3 participants