Skip to content

Conversation

@zpao
Copy link
Member

@zpao zpao commented Oct 15, 2013

I learned about gq in vim and 10 minutes later I realized I'd done all of our docs.

I'm not sure if we should do this - it might end up making it more awkward in the future to edit docs. But I wanted to show it to people before I made that decision myself.

I learned about `gq` and 10 minutes later I realized I'd done all of our
docs.
@vjeux
Copy link
Contributor

vjeux commented Oct 15, 2013

image

@brianr
Copy link
Contributor

brianr commented Oct 15, 2013

In addition to making docs harder to edit in the future, this will make diffs harder to read and the revision history cluttered with whitespace adjustments. I like line length rules for code; not so sure about English prose.

edit: s/whitespace rules/line length rules/

@sophiebits
Copy link
Collaborator

We could try to break after sentences; I've heard some people like doing that and it produces reasonable diffs.

@zpao
Copy link
Member Author

zpao commented Oct 15, 2013

Yea, I usually break at sentences when I write HTML. That's probably a pretty reasonable middle ground. I know this got out of hand relying on vim here. I don't necessarily agree with all the formatting it did, and I suppose I can't depend on all of you using vim and formatting before committing :)

@zpao
Copy link
Member Author

zpao commented Oct 15, 2013

Not going to do this but if somebody wants to go crazy and split to sentence-per-line, that might be fine.

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.

4 participants