Fix python syntax in modm_tools

[rleh]

With recent python versions there are a lot of warnings (DeprecationWarning until python 3.11, SyntaxWarning from version 3.12 onwards) generated from the modm_tools python code:

$ scons
scons: Reading SConscript files ...
/...blink/modm/modm_tools/bmp.py:13: SyntaxWarning: invalid escape sequence '\*'
  """
/.../blink/modm/modm_tools/build_id.py:13: SyntaxWarning: invalid escape sequence '\*'
[...]

Is it necessary to adapt the way this doc strings are extracted form the python files, @salkinium? I don't know where exactly that happens...

[salkinium]

These docs are assembled here:

modm/tools/build_script_generator/module.lb

Lines 20 to 43 in 23f64ca

	class BuildModuleDocs:
	def __init__(self):
	self._content = None
	def __str__(self):
	if self._content is None:
	self._content = Path(localpath("module.md")).read_text(encoding="utf-8").strip()
	tools = ["avrdude", "openocd", "bmp", "gdb", "size", "info", "jlink",
	"unit_test", "itm", "rtt", "build_id", "bitmap", "elf2uf2"]
	for tool in tools:
	tpath = Path(repopath("tools/modm_tools/{}.py".format(tool)))
	doc = None
	# Documentation is inside a Markdown file
	if tpath.with_suffix(".md").exists():
	doc = tpath.with_suffix(".md").read_text(encoding="utf-8")
	# Documentation is inside the tool as a docstring
	elif tpath.exists():
	doc = re.search('"""(.*?)"""', tpath.read_text(encoding="utf-8"), flags=re.DOTALL | re.MULTILINE)
	if doc: doc = doc.group(1);
	if doc is not None:
	self._content += "\n\n\n" + doc.strip()
	return self._content

Best check with lbuild discover -n :build if the * star is still displayed correctly. I forgot that doesn't do any formatting, so it'll display \*. 🤦

[salkinium]

Hm, I don't know, the homepage built test shows that the * star is also rendered \*.

[salkinium]

It makes the website show \* instead of *. Do we want to use this one instead? ✱

[calebchalmers]

Could you simply remove the slashes and put (* *only ...*) in the doc strings? I believe the first asterisk will be preserved in markdown because of the space after it.

[rleh]

Using raw string seems to work fine:

Comparison screenshots 🖼️ 🖼️

[salkinium]

Awesome, thanks!