Improved documentation for real_asyncio parameter and added docstrings #565
Conversation
This file contains 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
Fixes spulec#561 Add documentation for the `real_asyncio` parameter and improve API documentation. * **README.rst** - Add documentation for the `real_asyncio` parameter in the "Usage" section. - Add succinct API documentation with all options listed in the "Usage" section. * **freezegun/api.py** - Add docstrings to the `_freeze_time` class and its methods. - Add docstrings to the `freeze_time` function. * **CHANGELOG** - Add an entry mentioning the `real_asyncio` parameter in the "1.4.0" section. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/spulec/freezegun/issues/561?shareId=XXXX-XXXX-XXXX-XXXX).
Fixes spulec#561 Add documentation for the `real_asyncio` parameter and improve API documentation. * README.rst - Add documentation for the `real_asyncio` parameter in the "Usage" section. - Add succinct API documentation with all options listed in the "Usage" section. * freezegun/api.py - Add docstrings to the `_freeze_time` class and its methods. - Add docstrings to the `freeze_time` function. * CHANGELOG - Add an entry mentioning the `real_asyncio` parameter in the "1.4.0" section. ---
…t/freezegun into improve-documentation
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.
Fixes #561
Add documentation for the
real_asyncioparameter and improve API documentation.README.rst
real_asyncioparameter in the "Usage" section.freezegun/api.py
_freeze_timeclass and its methods.freeze_timefunction.CHANGELOG
real_asyncioparameter in the "1.4.0" section.For more details, open the Copilot Workspace session.