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.

Sign up for GitHub

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

Jump to bottom

docs: add docstrings #58

Merged
merged 4 commits into from
Feb 22, 2024
Merged

docs: add docstrings #58

merged 4 commits into from
Feb 22, 2024

Conversation

psychedelicious
Copy link
Contributor

Discussion items:

  1. I was fairly verbose, describing args, exceptions and providing examples. Maybe some of this - like examples - should only be in the README.
  2. I've documented the API to the best of my understanding 😅 there may be incorrect things, please take care when reviewing. Once any errors are corrected, I'm happy to also update the README.

melvinkcx
melvinkcx requested changes Feb 22, 2024
View reviewed changes
Copy link
Owner

@melvinkcx melvinkcx left a comment

Choose a reason for hiding this comment

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

Thanks @psychedelicious! Just a minor comment, otherwise, LGTM!

fastapi_events/dispatcher.py Outdated Show resolved Hide resolved
melvinkcx
melvinkcx approved these changes Feb 22, 2024
View reviewed changes
Copy link
Owner

@melvinkcx melvinkcx left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@melvinkcx melvinkcx merged commit c08c3f7 into melvinkcx:dev Feb 22, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@melvinkcx melvinkcx melvinkcx approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@psychedelicious @melvinkcx