Skip to content

Update runtime_troubles docs #13680

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 6 commits into from
Sep 20, 2022
Merged

Conversation

hauntsaninja
Copy link
Collaborator

@hauntsaninja hauntsaninja commented Sep 19, 2022

See #13681

PEP 563 is in limbo, so fix incorrect statements

Mention what type comments are since we've deleted most documentation of type comments when dropping support for Python 2

The new docs theme underemphasises notes, so maybe warning role is better

PEP 563 is in limbo, so fix incorrect statements

Mention what type comments are since we've deleted most documentation of
type comments when dropping support for Python 2

The new docs theme underemphasises notes, so maybe warning role is
better
Copy link
Collaborator

@JukkaL JukkaL left a comment

Choose a reason for hiding this comment

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

LGTM. One question about type comments (not necessary to address here).


a = 1 # type: int

def f(x): # type: (int) -> int
Copy link
Collaborator

Choose a reason for hiding this comment

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

By the way, are multi-line function type comments documented somewhere, i.e. comments like these:

def f(x,  # type: int
      y,  # type: str
):
    # type: (...) -> None
    ...

Copy link
Collaborator Author

@hauntsaninja hauntsaninja Sep 20, 2022

Choose a reason for hiding this comment

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

Not any more, I think they were only documented in the Python 2 cheatsheet (RIP)

@hauntsaninja hauntsaninja merged commit f8d6e7d into python:master Sep 20, 2022
@hauntsaninja hauntsaninja deleted the runtime-troubl branch September 20, 2022 17:33
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.

2 participants