search

jbt / docker

Documentation generator
http://jbt.github.com/docker
MIT License
233 stars 56 forks source link

Code blocks don't align properly with long comments #21

Closed adambiggs closed 11 years ago

adambiggs commented 11 years ago

Long comments don't line up with the code they're talking about, due to the vertical-align rule on line 229 of _base.sass:

td.code
  padding: 8px 15px 8px 25px
  width: 100%
  vertical-align: bottom
  border-left: 1px solid

Changing vertical-align to top makes things look much cleaner.

jbt commented 11 years ago

This one's a bit tricky because of the various use-cases. I had it set as bottom because I personally tend to write a big long jsDoc comment before a function and then some more commenting on the first line inside the function, which can lead to some crazy whitespace and a random orphan code line nowhere near anything else (search for decideWhetherToProcess on http://jbt.github.com/docker/src/docker.js.html), but actually aligning to top is a lot more logical in most cases.