fedor/BreezeX_Cursor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

👔 Uniform docstring inside builder module

Browse Source
This commit is contained in:
ful1e5
2021-04-25 16:56:16 +05:30
parent 68329a3cfd
commit 5f655b1fcd
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
builder/bxbuild/generator.py
+10 -10
View File
@@ -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. """Build `BreezeX` cursor theme for only `X11`(UNIX) platform.
:param config: `BreezeX` configuration. :param config: `BreezeX` configuration.
:type config: Dict :type config: ``Dict``
:param x_out_dir: Path to the output directory,\ :param x_out_dir: Path to the output directory,\
Where the `X11` cursor theme package will generate.\ Where the `X11` cursor theme package will generate.\
It also creates a directory if not exists. 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 :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. """Build `BreezeX` cursor theme for only `Windows` platforms.
:param config: `BreezeX` configuration. :param config: `BreezeX` configuration.
:type config: Dict :type config: ``Dict``
:param win_out_dir: Path to the output directory,\ :param win_out_dir: Path to the output directory,\
Where the `Windows` cursor theme package will generate.\ Where the `Windows` cursor theme package will generate.\
It also creates a directory if not exists. 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 :type info: Info
""" """
@@ -82,19 +82,19 @@ def build(
"""Build `BreezeX` cursor theme for `X11` & `Windows` platforms. """Build `BreezeX` cursor theme for `X11` & `Windows` platforms.
:param config: `BreezeX` configuration. :param config: `BreezeX` configuration.
:type config: Dict :type config: ``Dict``
:param x_out_dir: Path to the output directory,\ :param x_out_dir: Path to the output directory,\
Where the `X11` cursor theme package will generate.\ Where the `X11` cursor theme package will generate.\
It also creates a directory if not exists. 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,\ :param win_out_dir: Path to the output directory,\
Where the `Windows` cursor theme package will generate.\ Where the `Windows` cursor theme package will generate.\
It also creates a directory if not exists. 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 :type info: Info
""" """
builder/bxbuild/symlinks.py
+1 -1
View File
@@ -11,7 +11,7 @@ def add_missing_xcursor(directory) -> None:
"""Add missing `XCursor` to the Unix cursor package. """Add missing `XCursor` to the Unix cursor package.
:param directory: directory where XCursors are available. :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]]]] = [ symlinks: List[Dict[str, Union[str, List[str]]]] = [