From 4b27d119875f28915cadfda5e4d163bb56284cef Mon Sep 17 00:00:00 2001 From: MomIsBestFriend <> Date: Fri, 3 Apr 2020 21:56:40 +0300 Subject: [PATCH 1/2] TYP: Fixed type annotaions in `scripts/validate_rst_title_capitalization` --- scripts/validate_rst_title_capitalization.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/validate_rst_title_capitalization.py b/scripts/validate_rst_title_capitalization.py index 59d422a1605a0..80a2874184878 100755 --- a/scripts/validate_rst_title_capitalization.py +++ b/scripts/validate_rst_title_capitalization.py @@ -14,7 +14,7 @@ import os import re import sys -from typing import Generator, List, Tuple +from typing import Iterator, List, Tuple CAPITALIZATION_EXCEPTIONS = { "pandas", @@ -148,7 +148,7 @@ def correct_title_capitalization(title: str) -> str: return correct_title -def find_titles(rst_file: str) -> Generator[Tuple[str, int], None, None]: +def find_titles(rst_file: str) -> Iterator[Tuple[str, int]]: """ Algorithm to identify particular text that should be considered headings in an RST file. @@ -184,7 +184,7 @@ def find_titles(rst_file: str) -> Generator[Tuple[str, int], None, None]: previous_line = line -def find_rst_files(source_paths: List[str]) -> Generator[str, None, None]: +def find_rst_files(source_paths: List[str]) -> Iterator[str]: """ Given the command line arguments of directory paths, this method yields the strings of the .rst file directories that these paths contain. @@ -214,7 +214,7 @@ def find_rst_files(source_paths: List[str]) -> Generator[str, None, None]: yield filename -def main(source_paths: List[str], output_format: str) -> bool: +def main(source_paths: List[str], output_format: str) -> int: """ The main method to print all headings with incorrect capitalization. From ac9988dd7377e8421058eb05511ec3428388eb4c Mon Sep 17 00:00:00 2001 From: MomIsBestFriend <> Date: Fri, 3 Apr 2020 22:17:24 +0300 Subject: [PATCH 2/2] Iterator -> Iterable --- scripts/validate_rst_title_capitalization.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/validate_rst_title_capitalization.py b/scripts/validate_rst_title_capitalization.py index 80a2874184878..3d19e37ac7a1d 100755 --- a/scripts/validate_rst_title_capitalization.py +++ b/scripts/validate_rst_title_capitalization.py @@ -14,7 +14,7 @@ import os import re import sys -from typing import Iterator, List, Tuple +from typing import Iterable, List, Tuple CAPITALIZATION_EXCEPTIONS = { "pandas", @@ -148,7 +148,7 @@ def correct_title_capitalization(title: str) -> str: return correct_title -def find_titles(rst_file: str) -> Iterator[Tuple[str, int]]: +def find_titles(rst_file: str) -> Iterable[Tuple[str, int]]: """ Algorithm to identify particular text that should be considered headings in an RST file. @@ -184,7 +184,7 @@ def find_titles(rst_file: str) -> Iterator[Tuple[str, int]]: previous_line = line -def find_rst_files(source_paths: List[str]) -> Iterator[str]: +def find_rst_files(source_paths: List[str]) -> Iterable[str]: """ Given the command line arguments of directory paths, this method yields the strings of the .rst file directories that these paths contain.