From c459e3bb9553e31224348b055aaaec3a567613bb Mon Sep 17 00:00:00 2001 From: Cody Logan Date: Tue, 14 Nov 2023 16:56:15 -0800 Subject: Docstring type fixes --- src/wikiget/dl.py | 4 ++-- src/wikiget/file.py | 2 +- src/wikiget/parse.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) (limited to 'src/wikiget') diff --git a/src/wikiget/dl.py b/src/wikiget/dl.py index abd0533..9b2777f 100644 --- a/src/wikiget/dl.py +++ b/src/wikiget/dl.py @@ -49,7 +49,7 @@ def prep_download(dl: str, args: Namespace) -> File: :type args: argparse.Namespace :raises FileExistsError: the destination file already exists on disk :return: a File object representing the file to download - :rtype: File + :rtype: wikiget.file.File """ file = get_dest(dl, args) @@ -169,7 +169,7 @@ def download(f: File, args: Namespace) -> int: """Fetch file information and contents if the file exists and save it to disk. :param f: a File object representing the file to be downloaded - :type f: File + :type f: wikiget.file.File :param args: command-line arguments and their values :type args: argparse.Namespace :return: number of errors encountered during processing diff --git a/src/wikiget/file.py b/src/wikiget/file.py index f2320b2..cbd738a 100644 --- a/src/wikiget/file.py +++ b/src/wikiget/file.py @@ -54,7 +54,7 @@ class File: """Compare this File object with another for equality. :param other: another File to compare - :type other: File + :type other: wikiget.file.File :return: True if the Files are equal and False otherwise :rtype: bool """ diff --git a/src/wikiget/parse.py b/src/wikiget/parse.py index 92726f0..1deaacf 100644 --- a/src/wikiget/parse.py +++ b/src/wikiget/parse.py @@ -42,7 +42,7 @@ def get_dest(dl: str, args: Namespace) -> File: :type args: argparse.Namespace :raises ParseError: the target was unable to be parsed as a valid file :return: a File object representing the target, destination, and site - :rtype: File + :rtype: wikiget.file.File """ url = urlparse(dl) -- cgit v1.2.3