methods docs & import sorting

This commit is contained in:
ful1e5 2021-03-23 20:01:38 +05:30
parent b495940b97
commit bde717165b
4 changed files with 45 additions and 45 deletions

View file

@ -4,13 +4,12 @@
from pathlib import Path
from typing import Any, Dict, NamedTuple
from bbpkg.constants import AUTHOR, URL
from bbpkg.symlinks import add_missing_xcursor
from clickgen.builders import WindowsCursor, XCursor
from clickgen.core import CursorAlias
from clickgen.packagers import WindowsPackager, XPackager
from bbpkg.constants import AUTHOR, URL
from bbpkg.symlinks import add_missing_xcursor
class Info(NamedTuple):
name: str
@ -20,14 +19,16 @@ class Info(NamedTuple):
def xbuild(config: Dict[str, Dict[str, Any]], x_out_dir: Path, info: Info) -> None:
"""Build `Bibata` cursor theme for only `X11`(UNIX) platform.
```
:config: (Dict) `Bibata` configuration.
:param config: `Bibata` configuration.
:type config: Dict[str, Dict[str, Any]]
:x_out_dir: (Path) Path to the output directory,
Where the `X11` cursor theme package will generate.
It also creates a directory if not exists.
:info: (Dict) Content theme name & comment
```
: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
:param info: Content theme name & comment
:type info: Info
"""
for _, item in config.items():
@ -48,14 +49,16 @@ def xbuild(config: Dict[str, Dict[str, Any]], x_out_dir: Path, info: Info) -> No
def wbuild(config: Dict[str, Dict[str, Any]], win_out_dir: Path, info: Info) -> None:
"""Build `Bibata` cursor theme for only `Windows` platforms.
```
:config: (Dict) `Bibata` configuration.
:param config: `Bibata` configuration.
:type config: Dict[str, Dict[str, Any]]
:win_out_dir: (Path) Path to the output directory,
Where the `Windows` cursor theme package will generate.
It also creates a directory if not exists.
:info: (Dict) Content theme name & comment
```
: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
:param info: Content theme name & comment
:type info: Dict
"""
for _, item in config.items():
@ -88,18 +91,16 @@ def build(
) -> None:
"""Build `Bibata` cursor theme for `X11` & `Windows` platforms.
```
:config: (Dict) `Bibata` configuration.
:param config: `Bibata` configuration.
:type config: Dict[str, Dict[str, Any]]
:x_out_dir: (Path) Path to the output directory,
Where the `X11` cursor theme package will generate.
It also creates a directory if not exists.
: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
:win_out_dir: (Path) Path to the output directory,
Where the `Windows` cursor theme package will generate.
It also creates a directory if not exists.
:info: (Dict) Content theme name & comment
```
:param info: Content theme name & comment
:type info: Dict
"""
def win_build(item: Dict[str, Any], alias: CursorAlias) -> None: