Skip to content

Update runtime_troubles docs - #13680

Merged
hauntsaninja merged 6 commits into
python:masterfrom
hauntsaninja:runtime-troubl
Sep 20, 2022
Merged

hauntsaninja merged 6 commits into
python:masterfrom
hauntsaninja:runtime-troubl

Conversation

@hauntsaninja

@hauntsaninja hauntsaninja commented Sep 19, 2022 •

Copy link
Copy Markdown
Collaborator

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

@JukkaL JukkaL left a comment

Copy link
Copy Markdown
Collaborator

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
Copy Markdown
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
    ...

@hauntsaninja hauntsaninja Sep 20, 2022 •

Copy link
Copy Markdown
Collaborator Author

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