search

SolidCode / SolidPython

A python frontend for solid modelling that compiles to OpenSCAD
1.1k stars 172 forks source link

Pep8 examples/ #123

Closed Cabalist closed 4 years ago

Cabalist commented 4 years ago

This is a cleanup of the code in the examples/ dir. The primary goal was removing the import * pattern and removing cruft that might confuse a new user. I am aware of #114. I believe the desire for clarity is maintained here without the negative consequences of namespace pollution.

I noticed that there were some type hinting issues around translate() and extrude_along_path(). The code seems to function so it is probably too restrictive typing or incorrect assumptions about the args.

Again like my other PRs these commits should be broken into general themes. e950c53 converts some lists to tuples and should only leave the typing issues I mentioned above.

I love all these examples and it has made the code a lot more understandable. Thank you for including these. :)

etjones commented 4 years ago

Sweet! I’ll look these over after work and get everything merged. I’m so glad you’ve used these examples— I put a lot of time into them years ago because it seemed like the best way to explain concepts. I’ve never been sure if anyone used them, though, or if I should have made some more comprehensive step-by-step documentation with pictures. Did you find them quickly enough, or can you think of any ways to improve onboarding?

Cabalist commented 4 years ago

I think the biggest challenge is the necessity for OpenSCAD knowledge. Your documentation in the README with linking is top notch. After the TypeChecking branch was merged in I haven't had any issues.

If you were really pushing me for suggestions I would say add some images to the README to show what the output of the examples look like. :)

etjones commented 4 years ago

Thanks, Ryan!