adafruit / cookiecutter-adafruit-circuitpython

Cookiecutter template for Adafruit's CircuitPython libraries.
MIT License
22 stars 37 forks source link

Add note regarding package-prefix #219

Closed tekktrik closed 1 year ago

tekktrik commented 1 year ago

Adds note to help prevent https://github.com/adafruit/workflows-circuitpython-libs/issues/15 in the future. It's only needed for non-Adafruit libraries. Placing the Jinja tags the way I've done prevents unnecssary whitespace from being generated so black won't automatically need to address it (I tried using %- and such but didn't get it to line up any other way).

jposada202020 commented 1 year ago

This will need a mention in this learning guide, https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library.

tekktrik commented 1 year ago

Tagging @kattni for reference later, but I'll submit feedback to the guide (if this gets merged).