📚 kwargs docstring fixes

This commit is contained in:
ful1e5
2021-04-20 16:52:22 +05:30
parent 7f55b5bdd1
commit 1ea48738d7
+12 -7
View File
@@ -1,10 +1,11 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
from typing import Any, Dict, Tuple, TypeVar
from pathlib import Path
from typing import Any, Dict, Tuple, TypeVar, Union
from clickgen.util import PNGProvider
from bxpkg.constants import WIN_CURSORS_CFG, WIN_DELAY, X_CURSORS_CFG, X_DELAY
from clickgen.util import PNGProvider
X = TypeVar("X")
@@ -13,14 +14,13 @@ def to_tuple(x: X) -> Tuple[X, X]:
return (x, x)
def get_config(bitmaps_dir, **kwargs) -> Dict[str, Any]:
def get_config(bitmaps_dir: Union[str, Path], **kwargs) -> Dict[str, Any]:
"""Return configuration of `BreezeX` pointers.
:param bitmaps_dir: Path to .png file's directory.
:type bitmaps_dir: Union[str, Path]
:type bitmaps_dir: ``str`` or ``pathlib.Path``
:param \**kwargs:
:param **kwargs:
See below
:Keyword Arguments:
@@ -34,7 +34,12 @@ def get_config(bitmaps_dir, **kwargs) -> Dict[str, Any]:
Example:
```python
get_config("./bitmaps", x_sizes=[24, 32], win_canvas_size=32, win_size=24)
get_config(
bitmaps_dir="./bitmaps",
x_sizes=[24, 28, 32],
win_canvas_size=32,
win_size=24,
)
```
"""