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 app to events usage example #2191

Merged
merged 5 commits into from
Aug 22, 2023

Conversation

juan-riveros
Copy link
Contributor

@juan-riveros juan-riveros commented Aug 21, 2023

Pull Request Checklist

  • New code has 100% test coverage
  • (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
  • (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR

Description

  • Adds the app definition so that the example is provides all the information needed to make a functional example.
  • Currently, users will receive a ImproperlyConfiguredException(f"no event listeners are registered for event ID: {event_id}") as they aren't made aware to register listeners or where to register them.
  • Users would have to dive into the code to determine where the listener should be registered, this change exposes the need to add listeners to the application.

Feel free to disregard this if I am just misusing this or approached it incorrectly.

Add the `app` definition so that the example is provides all the information needed to make a functional example.
@juan-riveros juan-riveros requested review from a team as code owners August 21, 2023 17:54
fixed linting error failing the CI checks
@cofin
Copy link
Member

cofin commented Aug 22, 2023

@all-contributors add @juan-riveros for docs

@allcontributors
Copy link
Contributor

@cofin

I've put up a pull request to add @juan-riveros! 🎉

@cofin
Copy link
Member

cofin commented Aug 22, 2023

Thanks for taking the time to correct this! I'll merge as soon as it's validated.

@github-actions
Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2191

@cofin cofin merged commit aede6b9 into litestar-org:main Aug 22, 2023
17 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.

None yet

2 participants