Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pep8 examples/ #123

Merged
merged 11 commits into from
Oct 14, 2019
Merged

Pep8 examples/ #123

merged 11 commits into from
Oct 14, 2019

Conversation

Cabalist
Copy link
Contributor

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
Copy link
Contributor

etjones commented Oct 14, 2019

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
Copy link
Contributor Author

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 etjones merged commit 431aded into SolidCode:master Oct 14, 2019
@etjones
Copy link
Contributor

etjones commented Oct 14, 2019

Thanks, Ryan!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants