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

Already on GitHub? Sign in to your account

Remove superfluous code comments #1150

Merged
merged 1 commit into from Jul 31, 2012

Conversation

Projects
None yet
5 participants
Owner

necolas commented Jul 29, 2012

Reduce the perceived complexity and verbosity of certain files by
stripping unneccessary inline comments.

Relevant documentation may end up in a doc/ directory such that any
download has an accurate and matching code documentation bundle.

Ref gh-1048

Remove superfluous code comments
Reduce the perceived complexity and verbosity of certain files by
stripping unneccessary inline comments.

Relevant documentation may end up in a `doc/` directory such that any
download has an accurate and matching code documentation bundle.

Ref gh-1048

:(

Owner

drublic commented Jul 30, 2012

This looks good from what I can see. It would be awesome to have the docs included in the repo so we can point to that in a comment (or better not :D). People will most likely see a folder in the repo more clearly than the wiki over here.

@necolas necolas merged commit 889e377 into master Jul 31, 2012

@mklabs mklabs referenced this pull request in yeoman/yeoman Aug 8, 2012

Closed

use strip-comments on h5bp download #46

d8uv commented on 889e377 Aug 14, 2012

This commit broke drop-in h5bp/ant-build-script

Owner

necolas replied Aug 14, 2012

That's an issue for the ant-build-script and has been raised here before. This project isn't going to leave pieces of code lying around just in case someone wants to use a build script that requires them. Most people don't use the build scripts. If you use the build script, then adding some HTML comments is a fairly minor step in the process of configuring it.

d8uv replied Aug 14, 2012

I'm not disagreeing, I'd rather have a clean h5bp than one littered with comments. I just wanted to comment in case it was a slip. (I lost 15 minutes on finding out why the build script stopped working, so... when this deadline stops looming, I'll see if I can help out the docs)

Thank you!

Owner

necolas replied Aug 14, 2012

No worries. If you want to help out, and the ant-build-script docs are not clear or up to date, please do feel free to improve that project's docs. It would be much appreciated! :)

d8uv replied Aug 15, 2012

h5bp/ant-build-script@be424f7 solved my only complaint with this commit, so thanks! I love you all <3

Some of this lines are very constructive and one of the strengths of H5BP. I agree with most of this commit, but this one in particular and some others should stay as it avoids people reopening issues and improve awareness on why some of this came to be in the project.

I constantly point people to H5BP to learn front-end best practices, but some of the removals may hide this value that the project currently has.

Owner

necolas replied Aug 15, 2012

You can point them to the bundled docs instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment