-
Notifications
You must be signed in to change notification settings - Fork 4
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
Edit about.md for style and readability #5
base: master
Are you sure you want to change the base?
Conversation
YES TO 78CHAR LINE WIDTHS! 👍... looks good to me... @wannabeCitizen ? |
👏 " => ~/.vimrc
au BufRead,BufNewFile *.md setlocal textwidth=80 Haha. I'm somewhat 😢 about the fact that I changed the line width in this PR because it obscures the actual changes I made... Such as grammar, sentence re-wording, etc. I might go back and single-line those fools so you guys can see the grammar changes. |
Or maybe commit the line widths first then the grammar changes? That way it's easier to see where the grammar changes actually happened. Also, I'm all for 80char limits on everything... it's a good way to break people from writing those particularly long unreadable lines of code that do way too much (you know... the kind that I always end up writing?). |
976306d
to
b08b23f
Compare
After DoS attacking Github with all my force pushes, I think I got back all the diffs I could. It should at least help with reviewing the PR... I hope. After that is done I will fix dem style issues. |
Sorry to be off the boat currently. Grant writing is taking up all our Soon as I get back to Boulder tomorrow night, I'll be back in full swing Both of you can plan to see a first draft of the proposal sent out tonight On Wed, Jan 7, 2015 at 6:05 PM, Ian Ker-Seymer [email protected]
|
like the edits! are you planning on wrapping all lines at 80 characters, because it looks like there's still a lot of lines w/ more than that? |
Yeah, I undid those diffs to see if it would be easier to see the actual edits I made. I plan on redoing those line wraps after we get some 👍 action in this PR. |
When reading the about.md I decided it would be a good use of time to fix some markdown, and make some edits for readability. For markdown, I mainly just followed this styleguide.
Please comment on my writing edits. My goal was the keep the intent/message the same, but just make things flow off the tongue a bit more easily.
There are some issues with first-person/third-person conflation throughout the write-up we should address, and a few
TODO
's that are in there that we can address. I am happy to make some more passes on this to get sounding good.