deis / builder

Git server and application builder for Deis Workflow
https://deis.com
MIT License
40 stars 41 forks source link

fix(*): add godocs and address other golint issues #247

Closed arschles closed 8 years ago

arschles commented 8 years ago

Also:

Fixes #230

mboersma commented 8 years ago

Awesome! Two minor comments:

arschles commented 8 years ago

@mboersma thanks for the comments!

I'll modify this code to adhere to the 99 character limit, and I'll also ensure that we have complete sentences, with punctuation, in our docs. Commits forthcoming.

arschles commented 8 years ago

@mboersma 4b534587f96cf9b8e7b79a110f288520485a8819 and 3aa2eb408e7a889b67ac56312450da8de417290b limit comment lines (godoc and otherwise) to 99 chars and ensure that sentences are properly terminated.

Also, sidenote: I've created #251 to capture the work for writing package-level godocs. I'm considering that out of scope of this PR.

mboersma commented 8 years ago

There were already a lot of good documentation comments in here, and this improves many of them and fills in gaps where they were missing. This is excellent-I re-read this whole PR and I feel like I have a better understanding of builder just from that. :+1:

arschles commented 8 years ago

thanks @mboersma

fwiw, things will get even clearer after https://github.com/deis/builder/issues/152 is done, but I digress.... :see_no_evil:

arschles commented 8 years ago

Merged as part of v2.0-beta1, since I believe this will help new contributors to get started on the codebase