search

ClojureBridge / curriculum

Curriculum for the ClojureBridge workshop series.
https://clojurebridge.github.io/curriculum/
482 stars 199 forks source link

Remove expectations from curriculum #140

Closed k4y3ff closed 9 years ago

k4y3ff commented 9 years ago

Note: Feel free to suggest other titles for this PR, as it's probably pretty unclear as is.

It would probably be helpful for us to go through the curriculum and remove all instances of "You can probably guess what this is," "As you might expect," etc.--essentially, any phrase that implies the reader knows something, already. Then, we should rephrase those instances to focus on actions the reader should take.

For example, in intro.md, there's a line that reads

The first thing you notice are parentheses, probably.

That could be rephrased to

Notice the parentheses.

which shifts focus from what the reader knows to what the reader should do.

davidchambers commented 9 years ago

I like this idea. Another benefit is that sentences become shorter and clearer.

bridgethillyer commented 9 years ago

That's a very thoughtful suggestion. I think it's a great idea.

yokolet commented 9 years ago

Updated as in the suggestion, http://clojurebridge.github.io/curriculum/outline/intro.html#/3 . If you find this sort of expectations, open another issue. I'm going to close this one.