Formatting: Label data and configuration

j0ono0 / pinout

An open source Python package that generates hardware pinout diagrams as SVG images.

https://pinout.readthedocs.io

MIT License

390 stars 18 forks source link

Formatting: Label data and configuration #24

Closed j0ono0 closed 3 years ago

j0ono0 commented 3 years ago

Most recent tests separated label data from the pinout script - This keeps the script concise and clear. However the data file is overwhelmingly filled with repeated configuration settings. Ideally the file content should:

Clearly document label content in a readable way
Minimise visual clutter of repeated config settings (make it more DRY)
Cater for single config variable changes that affect all relevant label configs

j0ono0 commented 3 years ago

created a new module and class: config.PinConfig Allows filing of common config as dicts and updating instances of them at the point of use. PinConfig also generates label offset (a label equivalent to pin-pitch) allowing a looser relationship between pin spacing and and label spacing. Careful documentation will be required for this feature - it has some quirk due to how scale is implemented :/ PinConfig has been applied the the Arduino nano RP2040 Connect sample - outcome look good.