Get the documentation from the main function (#8)

.github/workflows/lint-test.yaml

@@ -3,8 +3,8 @@ name: Lint and test
 on:
   push:
     branches:
-      - "*"
-    tags-ignore: ["*"]
+      - "**"
+    tags-ignore: ["**"]
 
 jobs:
   lint:
@@ -45,3 +45,8 @@ jobs:
     - name: Run mypy
       run: |
         mypy --install-types --non-interactive .
+    - name: Run examples
+      run: |
+        ./example-simple.py
+        python example-inv.py -h
+

alphaconf/__init__.py

@@ -121,6 +121,17 @@ def run(main: Callable, arguments=True, *, should_exit=True, app: Application =
             for k in ['name', 'version', 'description', 'short_description']
             if k in config
         }
+        # if we don't have a description, get it from the function's docs
+        if 'description' not in properties and main.__doc__:
+            description = main.__doc__.strip().split('\n', maxsplit=1)
+            if 'short_description' not in properties:
+                properties['short_description'] = description[0]
+            if len(description) > 1:
+                import textwrap
+
+                properties['description'] = description[0] + '\n' + textwrap.dedent(description[1])
+            else:
+                properties['description'] = properties['short_description']
         app = Application(**properties)
     try:
         app.setup_configuration(arguments, **config)

example-simple.py

@@ -24,7 +24,7 @@
 
 
 def main():
-    """Demo application"""
+    """Simple demo of alphaconf"""
     # you can log extra values with formatters such as json, try:
     # ./example-simple.py logging.handlers.console.formatter=json
     logging.info('The app is running...', extra={'other': 'othervalue'})
@@ -50,5 +50,4 @@ def main():
         main,
         name='example',
         version='0.1',
-        description="Simple demo of alphaconf",
     )