From cb0a44630a0608994116e3de3be07b6d3b14381a Mon Sep 17 00:00:00 2001 From: Federico Padua Date: Tue, 4 Jul 2023 16:28:49 +0200 Subject: [PATCH] Fix variable name in comment in `getting_started.rst` (#15587) This PR fixes a word within a code block of the `Getting Started/Types from libraries` documentation. In particular, the variable name `file_path` is used instead of the correct `template_path`. This commit fixes that and it replaces `file_path` with `template_path`. This PR doesn't change the behaviour of `mypy` code since it involves just a word change in the documentation, so no tests are provided and it is expected that current working code works as usual, given the change made by this PR. --- docs/source/getting_started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 11f915005695..463c73b2fe76 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -264,7 +264,7 @@ Python standard library. For example, here is a function which uses the from pathlib import Path def load_template(template_path: Path, name: str) -> str: - # Mypy knows that `file_path` has a `read_text` method that returns a str + # Mypy knows that `template_path` has a `read_text` method that returns a str template = template_path.read_text() # ...so it understands this line type checks return template.replace('USERNAME', name)