[board] Merge split descriptions

Author: salkinium

repo.lb

@@ -230,7 +230,7 @@ def init(repo):
         if (module.parent / "module.md").exists():
             description = FileReader(str(module.parent / "module.md"))
         else:
-            description = re.search(r'\.description += +(""".*?"""|".*?")',
+            description = re.search(r'description += +(""".*?"""|".*?")',
                                     module_text, flags=re.S|re.M)
             description = description.group(1).strip('"\\') if description else None
         versions = re.search(r"#+ +[Rr]evisions? += +\[(.*)\]", module_text)

src/modm/board/black_pill_f103/module.lb

@@ -11,9 +11,7 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 # -----------------------------------------------------------------------------
 
-def init(module):
-    module.name = ":board:black-pill-f103"
-    module.description = """\
+description = """
 # Black Pill
 
 STM32F103C8T6 "Black Pill" Minimum System Development Board
@@ -22,9 +20,7 @@ Cheap and bread-board-friendly board for STM32 F1 series.
 Sold for less than 2 USD on well known Internet shops from China.
 
 https://stm32-base.org/boards/STM32F103C8T6-Black-Pill.html
-""" + descr_programming
 
-descr_programming = """
 ## Programming
 
 Since the board doesn't have a programmer on-board, you need to use your
@@ -54,6 +50,10 @@ Then include this file in your build options like so:
 ```
 """
 
+def init(module):
+    module.name = ":board:black-pill-f103"
+    module.description = description
+
 def prepare(module, options):
     if not options[":target"].partname.startswith("stm32f103c8t"):
         return False
@@ -81,4 +81,4 @@ def build(env):
 
     # Warn the user if they forgot to set a custom openocd config
     if env.has_option(":build:openocd.cfg") and not len(env.get(":build:openocd.cfg", "")):
-        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + descr_programming)
+        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + description)

src/modm/board/blue_pill_f103/module.lb

@@ -11,9 +11,7 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 # -----------------------------------------------------------------------------
 
-def init(module):
-    module.name = ":board:blue-pill-f103"
-    module.description = """\
+description = """
 # Blue Pill
 
 STM32F103C8T6 "Blue Pill" Minimum System Development Board
@@ -22,9 +20,7 @@ Cheap and bread-board-friendly board for STM32 F1 series.
 Sold for less than 2 USD on well known Internet shops from China.
 
 https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill.html
-""" + descr_programming
 
-descr_programming = """
 ## Programming
 
 Since the board doesn't have a programmer on-board, you need to use your
@@ -54,6 +50,10 @@ Then include this file in your build options like so:
 ```
 """
 
+def init(module):
+    module.name = ":board:blue-pill-f103"
+    module.description = description
+
 def prepare(module, options):
     if not options[":target"].partname.startswith("stm32f103c8t"):
         return False
@@ -81,4 +81,4 @@ def build(env):
 
     # Warn the user if they forgot to set a custom openocd config
     if env.has_option(":build:openocd.cfg") and not len(env.get(":build:openocd.cfg", "")):
-        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + descr_programming)
+        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + description)

src/modm/board/devebox_stm32h750vb/module.lb

@@ -10,9 +10,7 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 # -----------------------------------------------------------------------------
 
-def init(module):
-    module.name = ":board:devebox-stm32h750vb"
-    module.description = """\
+description = """
 # STM32F750VB mcudev DevEBox
 
 [STM32F750VB mcudev DevEBox H7xx](https://github.com/mcauser/MCUDEV_DEVEBOX_H7XX_M)
@@ -34,9 +32,7 @@ target option in your `project.xml`:
   </options>
 </library>
 ```
-""" + descr_programming
 
-descr_programming = """
 ## Programming
 
 Since the board doesn't have a programmer on-board, you need to use your
@@ -66,6 +62,10 @@ Then include this file in your build options like so:
 ```
 """
 
+def init(module):
+    module.name = ":board:devebox-stm32h750vb"
+    module.description = description
+
 def prepare(module, options):
     if not options[":target"].partname.startswith("stm32h750vbt"):
         return False
@@ -95,4 +95,4 @@ def build(env):
 
     # Warn the user if they forgot to set a custom openocd config
     if env.has_option(":build:openocd.cfg") and not len(env.get(":build:openocd.cfg", "")):
-        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + descr_programming)
+        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + description)

src/modm/board/stm32f030f4p6_demo/module.lb

@@ -11,9 +11,7 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 # -----------------------------------------------------------------------------
 
-def init(module):
-    module.name = ":board:stm32f030_demo"
-    module.description = """\
+description = """
 # STM32F030 Demo Board
 
 STM32F030F4P6 Minimum System Development Board.
@@ -22,9 +20,7 @@ Cheap and bread-board-friendly board for STM32 F0 series.
 Sold for less than 1.5 USD on well known Internet shops from China.
 
 https://stm32-base.org/boards/STM32F030F4P6-STM32F030-DEMO-BOARD-V1.1
-""" + descr_programming
 
-descr_programming = """
 ## Programming
 
 Since the board doesn't have a programmer on-board, you need to use your
@@ -51,6 +47,10 @@ Then include this file in your build options like so:
 ```
 """
 
+def init(module):
+    module.name = ":board:stm32f030_demo"
+    module.description = description
+
 def prepare(module, options):
     if not options[":target"].partname.startswith("stm32f030f4p"):
         return False
@@ -78,4 +78,4 @@ def build(env):
 
     # Warn the user if they forgot to set a custom openocd config
     if env.has_option(":build:openocd.cfg") and not len(env.get(":build:openocd.cfg", "")):
-        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + descr_programming)
+        env.log.warning("You need to provide the programmer via a custom OpenOCD config!\n" + description)