From 5f655b1fcd49307ac5915e0370be4ee904a1de49 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sun, 25 Apr 2021 16:56:16 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=91=94=20Uniform=20docstring=20inside=20b?= =?UTF-8?q?uilder=20module?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- builder/bxbuild/generator.py | 20 ++++++++++---------- builder/bxbuild/symlinks.py | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/builder/bxbuild/generator.py b/builder/bxbuild/generator.py index fdd7fe5..9dcef11 100644 --- a/builder/bxbuild/generator.py +++ b/builder/bxbuild/generator.py @@ -21,14 +21,14 @@ def xbuild(config: Dict[str, Dict[str, Any]], x_out_dir: Path, info: Info) -> No """Build `BreezeX` cursor theme for only `X11`(UNIX) platform. :param config: `BreezeX` configuration. - :type config: Dict + :type config: ``Dict`` :param x_out_dir: Path to the output directory,\ Where the `X11` cursor theme package will generate.\ It also creates a directory if not exists. - :type x_out_dir: Path + :type x_out_dir: ``pathlib.Path`` - :param info: Content theme name & comment + :param info: Content theme name & comment. :type info: Info """ @@ -47,14 +47,14 @@ def wbuild(config: Dict[str, Dict[str, Any]], win_out_dir: Path, info: Info) -> """Build `BreezeX` cursor theme for only `Windows` platforms. :param config: `BreezeX` configuration. - :type config: Dict + :type config: ``Dict`` :param win_out_dir: Path to the output directory,\ Where the `Windows` cursor theme package will generate.\ It also creates a directory if not exists. - :type win_out_dir: Path + :type win_out_dir: ``pathlib.Path`` - :param info: Content theme name & comment + :param info: Content theme name & comment. :type info: Info """ @@ -82,19 +82,19 @@ def build( """Build `BreezeX` cursor theme for `X11` & `Windows` platforms. :param config: `BreezeX` configuration. - :type config: Dict + :type config: ``Dict`` :param x_out_dir: Path to the output directory,\ Where the `X11` cursor theme package will generate.\ It also creates a directory if not exists. - :type x_out_dir: Path + :type x_out_dir: ``pathlib.Path`` :param win_out_dir: Path to the output directory,\ Where the `Windows` cursor theme package will generate.\ It also creates a directory if not exists. - :type win_out_dir: Path + :type win_out_dir: ``pathlib.Path`` - :param info: Content theme name & comment + :param info: Content theme name & comment. :type info: Info """ diff --git a/builder/bxbuild/symlinks.py b/builder/bxbuild/symlinks.py index d80480d..f5a853a 100644 --- a/builder/bxbuild/symlinks.py +++ b/builder/bxbuild/symlinks.py @@ -11,7 +11,7 @@ def add_missing_xcursor(directory) -> None: """Add missing `XCursor` to the Unix cursor package. :param directory: directory where XCursors are available. - :type directory: Union[str, Path] + :type directory: ``str`` or ``pathlib.Path`` """ symlinks: List[Dict[str, Union[str, List[str]]]] = [