Skip to content

Commit 2a6a8da

Browse files
committed
Add some informative pydoc comments
1 parent 9a849ca commit 2a6a8da

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

aw_qt/config.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@
1717
default_config['aw-qt-testing'] = default_settings
1818
qt_config = load_config("aw-qt", default_config)
1919

20-
20+
"""
21+
An instance of loaded settings, containing a list of modules to autostart.
22+
Constructor takes a `testing` boolean as an argument
23+
"""
2124
class AwQtSettings:
2225
def __init__(self, testing: bool):
2326
config_section = qt_config["aw-qt" if not testing else "aw-qt-testing"]

aw_qt/manager.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,7 @@ def _locate_executable(name: str) -> Optional[str]:
5252
return None
5353

5454

55-
"""
56-
Look for modules in given directory path and recursively in subdirs matching aw-*
57-
"""
55+
""" Look for modules in given directory path and recursively in subdirs matching aw-* """
5856
def _discover_modules_in_directory(modules: List[str], search_path: str) -> None:
5957
matches = glob(os.path.join(search_path, "aw-*"))
6058
for match in matches:
@@ -66,7 +64,7 @@ def _discover_modules_in_directory(modules: List[str], search_path: str) -> None
6664
else:
6765
logger.warning("Found matching file but was not executable: {}".format(match))
6866

69-
67+
""" Use _discover_modules_in_directory to find all bundled modules """
7068
def _discover_modules_bundled() -> List[str]:
7169
modules: List[str] = []
7270
cwd = os.getcwd()
@@ -78,7 +76,7 @@ def _discover_modules_bundled() -> List[str]:
7876
logger.info("Found no bundles modules")
7977
return modules
8078

81-
79+
""" Find all aw- modules in PATH """
8280
def _discover_modules_system() -> List[str]:
8381
search_paths = os.environ["PATH"].split(":")
8482
modules = []

0 commit comments

Comments
 (0)