search

evilstreak / markdown-js

A Markdown parser for javascript
7.69k stars 863 forks source link

Update README.md #188

Closed samelawrence closed 10 years ago

samelawrence commented 10 years ago

-- Grammar fixes. Being an asshole and getting nitpicky.

evilstreak commented 10 years ago

Nitpicky grammar fixes are ace, but could you keep the text wrapped to 80 characters? (I'd also be happy with 72. The README isn't very consistent on choosing between those two values)

samelawrence commented 10 years ago

@evilstreak I intentionally made all paragraphs single-line since Github (and most text editors) support soft text wrapping, however, I'm a self-taught and very junior developer, so I'm not sure of protocol on this. Is there a reason we would manually restrict character count per line? It seems like this is a use case where more modern editors are doing the work for us, and it's a legacy concern to limit to 76 or 80 characters per line.

I'm interested to hear your thoughts on this, but I am more than happy to modify my PR to match your style preferences.

samelawrence commented 10 years ago

I'm closing this one, and have submitted a new PR with better fixes.

evilstreak commented 10 years ago

Re: your line length question — I spend most of my time in terminals and Vim, so find wrapped files significantly easier to work with.

samelawrence commented 10 years ago

@evilstreak Ah, ok, that makes sense.