search

LibrePCB / librepcb-parts-generator

A collection of scripts to generate parts for the LibrePCB default library
MIT License
7 stars 14 forks source link

README: Add some docs #60

Closed dbrgn closed 4 years ago

dbrgn commented 4 years ago

Document concepts like UUID caching and the entity classes.

dbrgn commented 4 years ago

Good point. In CI we use 3.5/3.6/3.7 (and I'm pretty sure 3.4 does not support all type annotations), so I added 3.5+ to the README.

The requirements are only required for testing and type checking, I added a note about that as well.

rnestler commented 4 years ago

Good point. In CI we use 3.5/3.6/3.7 (and I'm pretty sure 3.4 does not support all type annotations), so I added 3.5+ to the README.

I would even love to ditch 3.5 as well, since it also doesn't support certain type annotations and needs workarounds. Ubuntu LTS has 3.6 btw. :slightly_smiling_face:

dbrgn commented 4 years ago

Would be fine with me. You mean things like variable annotations with # type: comments, right?

rnestler commented 4 years ago

Would be fine with me. You mean things like variable annotations with # type: comments, right?

Yes, for example.