i poured all my knowledge into the cheat sheet #30

Closed
wants to merge 48 commits into
from

Projects

None yet

3 participants

@HamsterofDeath

checked it for typos, checked again, again and again :)
it still doesn't cover everything, but it's complete enough for a pull i think.

HamsterofDeath added some commits Dec 21, 2011
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 04e2179
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md fa3249f
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md e6ed517
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 7e31941
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 435c2ee
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md b65e5a8
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 64e3a1a
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md e0a9e64
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 62c8079
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 18a86ac
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 91699ed
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md a347230
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md e0b5768
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 6c3ce7f
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md ed54999
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 554b312
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 39760ba
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md e97319d
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md b124fc6
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 7038c41
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 43d9cf4
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 7f49dba
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 5e75bb8
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 68e76b0
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 29c2579
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 3cf82d2
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 44f2ab5
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 5a8a2bc
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 3debbc3
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 6508b0f
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 0018ed5
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 20ac84f
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md bd50939
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 778589d
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 839c542
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md 16aaa61
@HamsterofDeath HamsterofDeath Update cheatsheets/index.md d9a991c
@lerodcer

There is a lot of good content in this update, but I think it has several important issues.

It does not compile properly on my machine; Only once the "by" in the header has been fixed does it compile properly. Once it does compile, the code and explanation parts are switched a couple of times.
It is very wordy in many places. Cheat sheets should in general be concise.
The source is not formatted the same way as it was previously, making maintenance harder.
I notice that some parts has been removed, including parts of the pattern matching and parts of the functions section, including currying. Not all of these parts seems to have been replaced: I cannot find anything about currying, for instance.

Due to these issues, I would recommend that parts of this update should be extracted and added piece by piece, such that each piece can be reviewed properly and possibly be improved before including.

@HamsterofDeath

Am 31.12.2011 12:43, schrieb lerodcer:

There is a lot of good content in this update, but I think it has several important issues.
it was my first try ;)

It does not compile properly on my machine; Only once the "by" in the header has been fixed does it compile properly.

did i change that? i think it was broken before

Once it does compile, the code and explanation parts are switched a couple of times.
what do i have to change to fix it, so i can fix the switch as well?

It is very wordy in many places. Cheat sheets should in general be concise.

i went a little overboard at some spots. i'll just remove the words that
are not really necessary and split up the spooky collection method names
part

The source is not formatted the same way as it was previously, making maintenance harder.
you mean the indentation of the |? this is something a tool should do....

I notice that some parts has been removed, including parts of the pattern matching and parts of the functions section, including currying. Not all of these parts seems to have been replaced: I cannot find anything about currying, for instance.
currying went to the advanced declaration part (multiple parameter
lists). i didn't mention it's called currying, i can add that. i left
out the function composition part because it's pretty much completely
obvious you can do that.

Due to these issues, I would recommend that parts of this update should be extracted and added piece by piece, such that each piece can be reviewed properly and possibly be improved before including.
this won't work - if i add the sections one after another, the sheet
will always have a "random stuff that was not changed yet"-part at the
end. we would need an intermediate sheet.


Reply to this email directly or view it on GitHub:
#30 (comment)

@lerodcer

Regarding the compilation, the "by" part in the header should not include an ":". I think that is the only change needed for it to compile properly.

The switching is, as far as I can see, due to faulty use of "|". The easiest way to see where the faults are is probably by compiling and seeing the results; the README.md has compile instructions.

Regarding indentation, using a tool is a good idea. It shouldn't be too hard to write either. I think that it should be used before committing, simply because it makes the commits nicer and means that extra commits just for formatting is not needed. I seem to remember Google requiring that code is formatted before accept commits for some project of theirs.

Regarding finding things; you are right, it seems it is just name changes :).

Regarding the pieces, I think that it should be somewhat easy and possible to commit pieces and still have a proper cheat sheet at each step. I also think it would be worth it, simply because it is easier to review and improve.

@HamsterofDeath

Am 31.12.2011 17:01, schrieb lerodcer:

Regarding the compilation, the "by" part in the header should not include an ":". I think that is the only change needed for it to compile properly.

The switching is, as far as I can see, due to faulty use of "|". The easiest way to see where the faults are is probably by compiling and seeing the results; the README.md has compile instructions.

Regarding indentation, using a tool is a good idea. It shouldn't be too hard to write either. I think that it should be used before committing, simply because it makes the commits nicer and means that extra commits just for formatting is not needed. I seem to remember Google requiring that code is formatted before accept commits for some project of theirs.

Regarding finding things; you are right, it seems it is just name changes :).

Regarding the pieces, I think that it should be somewhat easy and possible to commit pieces and still have a proper cheat sheet at each step. I also think it would be worth it, simply because it is easier to review and improve.


Reply to this email directly or view it on GitHub:
#30 (comment)

i censored many, many words. as soon as i have fixed the rest, should i
revert my changes, add just one section and create another pull request?

@lerodcer
lerodcer commented Jan 1, 2012

Sounds awesome. Yeah, that would be great.

@HamsterofDeath

Am 01.01.2012 13:16, schrieb lerodcer:

Sounds awesome. Yeah, that would be great.


Reply to this email directly or view it on GitHub:
#30 (comment)

i wrote a little formatter, most of the | are now aligned. i made
exceptions for very long lines and multi-line-lines. about the compilation:
isn't there a button or something which simply lists the errors? why
doesn't the preview show the problems?

i get a lot of "bad cname"-errors via email. what does that mean?

@HamsterofDeath

Am 01.01.2012 13:16, schrieb lerodcer:

Sounds awesome. Yeah, that would be great.


Reply to this email directly or view it on GitHub:
#30 (comment)

are you talking about this readme?
i followed all the steps until i got this error message:

S:\scala_github>cd HamsterofDeath-scala.github.com-671225d

S:\scala_github\HamsterofDeath-scala.github.com-671225d>jekyll --server
C:/Ruby193/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in require': iconv will be deprecated in the future, use String#encode in stead. Configuration from S:/scala_github/HamsterofDeath-scala.github.com-671225d/_config.yml Building site: S:/scala_github/HamsterofDeath-scala.github.com-671225d -> S:/scala_github/HamsterofDeath-scala.github.com-671225d/ _site C:/Ruby193/lib/ruby/1.9.1/psych.rb:154:inparse': (): couldn't
parse YAML at line 3 column 20 (Psych::SyntaxError)
from C:/Ruby193/lib/ruby/1.9.1/psych.rb:154:in parse_stream' from C:/Ruby193/lib/ruby/1.9.1/psych.rb:125:inparse'
from C:/Ruby193/lib/ruby/1.9.1/psych.rb:112:in load' from C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/convertible.rb:33:inread_yaml'
from
C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/page.rb:24:in
initialize' from C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:140:innew'
from
C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:140:in
block in read_directories' from C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:130:ineach'
from
C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:130:in
read_directories' from C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:135:inblock in read_directories'
from
C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:130:in
each' from C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:130:inread_directories'
from
C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:98:in
read' from C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/lib/jekyll/site.rb:38:inprocess'
from
C:/Ruby193/lib/ruby/gems/1.9.1/gems/jekyll-0.11.2/bin/jekyll:250:in
<top (required)>' from C:/Ruby193/bin/jekyll:19:inload'
from C:/Ruby193/bin/jekyll:19:in `

'

what does it want from me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment