generated from jCloud/repository-template
chore: update API reference
This commit is contained in:
1 parent
cd35457301
commit
eabde41cec
14 files changed
+386
-57
No files matched your search
@@ -37,7 +37,11 @@ Return type: `None`
|
||||
| `args` | -- | vararg | -- | -- |
|
||||
| `kwargs` | -- | kwargs | -- | -- |
|
||||
|
||||
### Decorators
|
||||
|
||||
```python
|
||||
deprecated('Use pathlib.Path instead.')
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -84,7 +88,11 @@ Return type: `None`
|
||||
| `args` | -- | vararg | -- | -- |
|
||||
| `kwargs` | -- | kwargs | -- | -- |
|
||||
|
||||
### Decorators
|
||||
|
||||
```python
|
||||
deprecated('Use pathlib.Path instead.')
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -230,7 +238,7 @@ attribute)
|
||||
### Function signature
|
||||
|
||||
```python
|
||||
assert_that_is_instance(obj: object, class_or_tuple: Union[type, types.UnionType, tuple[type, ...]]) -> None
|
||||
assert_that_is_instance(obj: object, class_or_tuple: type | types.UnionType | tuple[type, ...]) -> None
|
||||
```
|
||||
|
||||
### Returns
|
||||
@@ -242,7 +250,7 @@ Return type: `None`
|
||||
| Parameter | Type | Kind | Default value | Description |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `obj` | `object` | normal | -- | -- |
|
||||
| `class_or_tuple` | `Union[type, types.UnionType, tuple[type, ...]]` | normal | -- | -- |
|
||||
| `class_or_tuple` | `type | types.UnionType | tuple[type, ...]` | normal | -- | -- |
|
||||
|
||||
## Function `non_empty_str`
|
||||
|
||||
@@ -256,20 +264,20 @@ Please note: values are stripped, i. e. if the value consists only
|
||||
### Function signature
|
||||
|
||||
```python
|
||||
non_empty_str(value: Union[str, None]) -> Union[str, None]
|
||||
non_empty_str(value: str | None) -> str | None
|
||||
```
|
||||
|
||||
### Returns
|
||||
|
||||
The value or ``None``.
|
||||
|
||||
Return type: `Union[str, None]`
|
||||
Return type: `str | None`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Kind | Default value | Description |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `value` | `Union[str, None]` | normal | -- | The value. |
|
||||
| `value` | `str | None` | normal | -- | The value. |
|
||||
|
||||
|
||||
|
||||
@@ -287,10 +295,10 @@ Please note: values are stripped, i. e. if the value consists only
|
||||
of spaces, it is also considered empty.
|
||||
|
||||
:param value: The value.
|
||||
:type value: Union[str, None]
|
||||
:type value: str | None
|
||||
|
||||
:return: The value or ``None``.
|
||||
:rtype: Union[str, None]
|
||||
:rtype: str | None
|
||||
|
||||
## Function `get_relative_path_segments`
|
||||
|
||||
|
||||
Reference in new issue
Block a user