Add some documentation#4
Open
pomeroyb wants to merge 12 commits into
Open
Conversation
# Conflicts: # sdf/d3.py
Owner
|
Thanks for the help! I've got the README and sample images under control, but I could pull in your docstrings - can you update your PR to only include those? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These docs aren't complete, but I figured it'd be good to start this pull request now so duplicate readmes aren't written.
Also you keep adding functions so the docstrings are also a bit behind!
The /docs/images folder I was planning to populate with images from your meshview program, but it may be better to now generate the images with the render.go util for consistency.