project-generator / project_generator

Project generators for various embedded tools (IDE). IAR, uVision, Makefile, CoIDE, Eclipse and many more in the roadmap!
Apache License 2.0
272 stars 95 forks source link

Use comment blocks when appropriate #511

Closed knowledgejunkie closed 9 months ago

knowledgejunkie commented 9 months ago

The docstring here triggers a Syntax Warning on Python 3.12, which in time will be raised to a SyntaxError, due to an invalid escape character.

When explaining the intricacies of code for developers, use comments.