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

Improvement/remove odd label comments #33

Conversation

Jeroen-Matthijssens
Copy link
Contributor

The .clearfix class has a comment explaining what the parts in the definition do, and why they are there. Each is labeled with a number. In the definition of the class the same numbers are used as labels but they are below the the line to which they apply.

/*
 * ...
 * 1. First explination
 * 2. Second explination
 */

.clearfix {
  content: " ",
  /* 1 */
}

I find this very counter intuitive. I would understand it being on the same line, or on the line before content, but not on a separate line below it. Originally the label was trailing on the same line [1]. However I think the comment does a good enough job at explaining the definition without the labels.

I see three possible solutions: putting them back where they where, putting them on the line above, or removing them altogether.

There is a similar situation in the definition of .visuallyhidden.

ps: Block comments where missing a space before on consecutive lines, which I have added.
pps: The commit in [1] also seems to be the one where the block comments got mangled.

[1] h5bp/html5-boilerplate@e1e7277

@Jeroen-Matthijssens Jeroen-Matthijssens force-pushed the improvement/remove-odd-label-comments branch from c4ff68b to 72847e0 Compare June 18, 2019 06:19
@roblarsen roblarsen merged commit d95371f into h5bp:master Sep 29, 2019
@roblarsen
Copy link
Member

Thanks. Good stuff.

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.

None yet

2 participants