Skip to content

Update documentation #11

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

Merged
merged 1 commit into from
Dec 22, 2024
Merged

Update documentation #11

merged 1 commit into from
Dec 22, 2024

Conversation

san-tekart
Copy link
Collaborator

  • Added a section in README.md to clarify the requirement of an existing asyncio event loop for using TSignal's decorators.
  • Updated the api.md to emphasize the need for a running event loop when using the @t_with_signals and @t_slot decorators.
  • Clarified that if no event loop is running, a RuntimeError will be raised.

Modified the core.py

  • Logs and raises an error message instead of creating a new event loop when none is found.

Update version

  • Incremented the version number in pyproject.toml from 0.4.2 to 0.4.3.

- Added a section in README.md to clarify the requirement of an existing asyncio event loop for using TSignal's decorators.
- Updated the api.md to emphasize the need for a running event loop when using the @t_with_signals and @t_slot decorators.
- Clarified that if no event loop is running, a RuntimeError will be raised.

Modified the core.py
- Logs and raises an error message instead of creating a new event loop when none is found.

Update version
- Incremented the version number in pyproject.toml from 0.4.2 to  0.4.3.
@san-tekart san-tekart merged commit 4b72210 into main Dec 22, 2024
3 checks passed
@san-tekart san-tekart deleted the 0.4.3 branch December 24, 2024 14:23
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.

1 participant