search

fogleman / primitive

Reproducing images with geometric primitives.
https://primitive.lol/
MIT License
12.35k stars 608 forks source link

Documenting functions #36

Closed thundergolfer closed 4 years ago

thundergolfer commented 7 years ago

Hey I thought your project was a beautiful idea, and became interested in reading through the code.

For what it's worth I have tried to document the functions in the code, from what I have gleaned from trying to comprehend the projects workings.

You yourself may not see them as being so good or useful (though I hope you do), but I thought they might help someone new coming to this project's codebase, so I thought I'd pull-request what I've done. It might save them time breaking down the codebase.

bmaltais commented 7 years ago

Nice contribution. Make it easier to understand what does what.

ZaLiTHkA commented 7 years ago

I like doc blocks... (: So pretty.

All jokes aside, I don't know Go in any capacity, yet I was able to follow the logic behind the inner workings with this. So either way you've already helped at least one person here, thanks for that.

thundergolfer commented 7 years ago

@ZaLiTHkA good to hear mate, that's exactly why I thought I'd add it.

Knowing more Go now, I think a lot of the functions I documented where actually self-documenting or trivial, but to a Go beginner I think the doc-string is useful.