Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ianks
Copy link
Contributor

@ianks ianks commented Jan 6, 2015

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.

@mynameisfiber
Copy link
Member

YES TO 78CHAR LINE WIDTHS!

👍... looks good to me... @wannabeCitizen ?

@ianks
Copy link
Contributor Author

ianks commented Jan 7, 2015

YES TO 78CHAR LINE WIDTHS!

👏

" => ~/.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.

@mynameisfiber
Copy link
Member

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?).

@ianks ianks force-pushed the edit-about branch 9 times, most recently from 976306d to b08b23f Compare January 7, 2015 23:01
@ianks
Copy link
Contributor Author

ianks commented Jan 7, 2015

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.

@wannabeCitizen
Copy link
Member

Sorry to be off the boat currently. Grant writing is taking up all our
daytime energy. I've had a list of changes to make to the ModuLearner site
and am very thankful to you Ian for getting to some of this stuff.

Soon as I get back to Boulder tomorrow night, I'll be back in full swing
looking at this code and stuff. Plus the grant is due 1/15 so we're in the
home stretch with that.

Both of you can plan to see a first draft of the proposal sent out tonight
for you to each give your feedback.

On Wed, Jan 7, 2015 at 6:05 PM, Ian Ker-Seymer [email protected]
wrote:

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.


Reply to this email directly or view it on GitHub
#5 (comment).

@veryeasily
Copy link
Contributor

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?

@ianks
Copy link
Contributor Author

ianks commented Jan 26, 2015

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.

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