Updated Path documentation and made is_junction() conditional #800
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
graingert
requested changes
Oct 13, 2024
| @@ -13,6 +13,9 @@ This library adheres to `Semantic Versioning 2.0 <http://semver.org/>`_. | |||
| - Fixed TaskGroup and CancelScope producing cyclic references in tracebacks | |||
| when raising exceptions (`#806 <https://github.com/agronholm/anyio/pull/806>`_) | |||
| (PR by @graingert) | |||
| - Corrected documentation on ``anyio.Path`` regarding the limitations imposed by the | |||
| current Python version on several of its methods, and made the ``is_junction`` method | |||
| unavailable on Python versions earlier than 3.12 | |||
graingert
approved these changes
Oct 13, 2024
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.
Changes
Updated the
anyio.Pathdocs to fix several omissions, and to mention limitations on earlier Python versions.Also, the
is_junction()method is now hidden unless on Python 3.12 or later, to match its stdlib counterpart (as it wouldn't work anyway).Fixes #794.
Checklist
If this is a user-facing code change, like a bugfix or a new feature, please ensure that
you've fulfilled the following conditions (where applicable):
tests/) added which would fail without your patchdocs/, in case of behavior changes or newfeatures)
docs/versionhistory.rst).If this is a trivial change, like a typo fix or a code reformatting, then you can ignore
these instructions.
Updating the changelog
If there are no entries after the last release, use
**UNRELEASED**as the version.If, say, your patch fixes issue #123, the entry should look like this:
* Fix big bad boo-boo in task groups (#123 <https://github.com/agronholm/anyio/issues/123>_; PR by @yourgithubaccount)If there's no issue linked, just link to your pull request instead by updating the
changelog after you've created the PR.