Merged
Conversation
…us and asynchronous functions
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request improves the documentation for the fspin library by clarifying the usage patterns for blocking vs fire-and-forget execution modes, reorganizing installation instructions, and providing comprehensive examples for both synchronous and asynchronous patterns.
- Added clear documentation distinguishing between blocking (
wait=True) and fire-and-forget (wait=False) patterns for both sync and async functions - Reorganized installation instructions to appear at the top of the README with a PyPI badge
- Enhanced the cheatsheet with detailed API references, code examples, and a quick reference section for blocking behavior
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| readme.md | Moved installation section to top, added comprehensive blocking vs fire-and-forget examples, improved cheatsheet description and positioning |
| fspin_cheatsheet.md | Expanded with detailed code examples for sync/async patterns, added blocking vs fire-and-forget quick reference section, enhanced API documentation |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
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.
This pull request updates the documentation for the
fspinlibrary, focusing on clarifying the usage patterns for blocking vs fire-and-forget execution modes, improving installation instructions, and providing more comprehensive examples and API references. The changes make it easier for developers to understand how to use threading and async features, and when to use thewaitflag. The readme and cheatsheet now include explicit guides and code samples for both synchronous and asynchronous patterns, as well as a quick reference for blocking behavior.Documentation improvements for blocking vs fire-and-forget usage:
fspin_cheatsheet.mdwith clear code examples and explanations for synchronous and asynchronous usage, detailing how thewaitflag affects blocking behavior for both decorators and context managers. Added a "Blocking vs fire-and-forget quick reference" section for easy lookup. [1] [2] [3] [4] [5] [6] [7]Readme enhancements:
readme.mdfor easier onboarding, including a PyPI badge and pip instructions.wait=Trueorwait=False. [1] [2]waitflag and when it is applicable. [1] [2]These updates make the documentation much clearer and help prevent common mistakes when using the library’s threading and async capabilities.