Skip to content
This repository was archived by the owner on Dec 24, 2025. It is now read-only.

Commit ed8be1e

Browse files
committed
update | preload flet package for additional property documentation
1 parent f394177 commit ed8be1e

3 files changed

Lines changed: 9 additions & 11 deletions

File tree

docs/license.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: Licence
3-
---
4-
51
```
62
--8<-- "LICENSE"
73
```

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ plugins:
127127
show_labels: false
128128
show_if_no_docstring: true
129129
docstring_section_style: spacy
130+
inherited_members: true
131+
preload_modules: [ flet ]
130132
filters:
131133
- "!^_" # Exclude private members starting with only one underscore
132134
- "^__" # Include private members starting with two underscores

src/flet_flashlight/exceptions.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
class FlashlightException(Exception):
2-
"""Base class for all Flashlight errors."""
2+
"""Base class for all Flashlight exceptions."""
33

44

55
class FlashlightEnableExistentUserException(FlashlightException):
66
"""
7-
Exception thrown when an attempt was made to turn on the torch
7+
An attempt was made to turn on the torch
88
but it was detected that the camera was being used by another process.
99
This means that the torch cannot be controlled.
1010
"""
1111

1212

1313
class FlashlightEnableNotAvailableException(FlashlightException):
1414
"""
15-
Exception thrown when an attempt was made to turn on the torch
15+
An attempt was made to turn on the torch
1616
but it was detected that the device does not have one equipped.
1717
"""
1818

1919

2020
class FlashlightEnableException(FlashlightException):
2121
"""
22-
Exception thrown when an error occurred while trying to turn on the device torch.
22+
An error occurred while trying to turn on the device torch.
2323
"""
2424

2525

2626
class FlashlightDisableExistentUserException(FlashlightException):
2727
"""
28-
Exception thrown when an attempt was made to turn off the torch
28+
An attempt was made to turn off the torch
2929
but it was detected that the camera was being used by another process.
3030
This means that the torch cannot be controlled.
3131
"""
3232

3333

3434
class FlashlightDisableNotAvailableException(FlashlightException):
3535
"""
36-
Exception thrown when an attempt was made to turn off the torch
36+
An attempt was made to turn off the torch,
3737
but it was detected that the device does not have one equipped.
3838
"""
3939

4040

4141
class FlashlightDisableException(FlashlightException):
4242
"""
43-
Exception thrown when an error occurred while trying to turn off the device torch.
43+
An error occurred while trying to turn off the device torch.
4444
"""

0 commit comments

Comments
 (0)