WICG / cq-usecases

Use cases and requirements for standardizing element queries.
Other
184 stars 24 forks source link

Few stylistic/editorial suggestions #21

Closed marcoscaceres closed 9 years ago

marcoscaceres commented 9 years ago

ping :)

yoavweiss commented 9 years ago

Is it possible to break out the long lines so that review would be easier in the future? Otherwise, LGTM

Wilto commented 9 years ago

Argh, completely missed the notification on this! I’ll give it a read/merge today.

marcoscaceres commented 9 years ago

I find it helps to turn of soft wrapping in GH. It's not practical to wrap lines in BS ... Unless we settle on a command line tool? Any suggestions?

On Friday, November 21, 2014, Yoav Weiss notifications@github.com wrote:

Is it possible to break out the long lines so that review would be easier in the future? Otherwise, LGTM

— Reply to this email directly or view it on GitHub https://github.com/ResponsiveImagesCG/eq-usecases/pull/21#issuecomment-63963343 .

marcoscaceres commented 9 years ago

I'll have to rebase this

marcoscaceres commented 9 years ago

Rebased ...

tabatkins commented 9 years ago

It's not practical to wrap lines in BS ...

(Interestingly, you turning off soft-wrapping in GH made the above blockquote look stupid, because there was a hard break between "wrap" and "lines" that I had to remove.)

What do you mean by this? Look at any Bikeshed file I or fantasai edit - we wrap lines consistently (using semantic line breaks, which are better both for editting and for diffing).

marcoscaceres commented 9 years ago

Ok, very valid point @tabatkins ... just needs a bit of a shift in thinking to "semantic line breaks" (and that all the editors agree to this!). The document is currently not written like that tho - so that will require someone to actually go through the whole thing and place breaks in natural places.

marcoscaceres commented 9 years ago

(I'm happy to do that, btw... but can we please merge this ... it's been like 10 days and feeling unloved :( )

Wilto commented 9 years ago

Oh, @marcoscaceres, you can totally feel free to merge changes—this doc is in a major state of flux, so feel free to self-merge when things get +1’d.

marcoscaceres commented 9 years ago

@Wilto thanks! will do.

tabatkins commented 9 years ago

Ok, very valid point @tabatkins ... just needs a bit of a shift in thinking to "semantic line breaks" (and that all the editors agree to this!).

I just suggested semantic linebreaks as a good way to do your linebreaking. Still curious what you meant by

It's not practical to wrap lines in BS ...

though.

marcoscaceres commented 9 years ago

@tabatkins, imagine I found a bug in the middle of a sentence but no semantic wrapping had been used - rather lines had been hand broken at around 80 cols. Trying to add new text in such situations becomes a huge pain (as described in the link you sent)

In other specs, I've always coped with this by forcing contributors to run HTML through HTML5 tidy. I'm not suggesting we do this here (because BS is not actually HTML, hence Tidy would just make a mess of things: hence "It's not practical to [computationally?] wrap lines in BS "). I was merely asking what our line breaking strategy would be (given that it has to be done manually).

tabatkins commented 9 years ago

Ah, ok, so your reference to "not practical" was "not practical to enforce with existing tooling". Cool.

marcoscaceres commented 9 years ago

exactly, sorry about the confusion!

marcoscaceres commented 9 years ago

(btw, I really like the semantic line break idea... It's a great natural fit for BS!)