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

Minor documentation updates #12329

Merged
merged 4 commits into from Mar 10, 2022
Merged

Minor documentation updates #12329

merged 4 commits into from Mar 10, 2022

Conversation

JukkaL
Copy link
Collaborator

@JukkaL JukkaL commented Mar 10, 2022

No description provided.

If you want to use coroutines in Python 3.4, which does not support
the ``async def`` syntax, you can instead use the :py:func:`@asyncio.coroutine <asyncio.coroutine>`
decorator to convert a generator into a coroutine.
If you use coroutines in code that was written for Python 3.4, which
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we just drop this? 3.4 is long dead

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess there may still legacy code that was originally written to support Python 3.4 and was never migrated to the new syntax, but this is pretty marginal. At least we could make this section shorter.

JukkaL and others added 2 commits March 10, 2022 16:37
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@@ -237,7 +237,7 @@ section of the command line docs.

[tool.mypy]
exclude = [
"^one\.py$", # TOML's double-quoted strings require escaping backslashes
"^one\\.py$", # TOML's double-quoted strings require escaping backslashes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the next line change too? Haven't tested this myself

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment indicates that single-quoted strings are different. I'll test his.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, single quotes behave differently, so the current example seems correct.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Sorry for missing the comment.

@JukkaL JukkaL merged commit 0d38613 into master Mar 10, 2022
@JukkaL JukkaL deleted the doc-tweaks branch March 10, 2022 17:45
JukkaL added a commit that referenced this pull request Mar 10, 2022
* Some minor documentation updates
* Add more discussion of exhaustiveness checking
* Update docs/source/literal_types.rst
* Simplify docs for legacy async

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
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