search

kotlin-hands-on / hands-on

Apache License 2.0
130 stars 176 forks source link

Update 03_A_Simple_API_Server.md #144

Closed mstephenp closed 3 years ago

mstephenp commented 3 years ago

Small typo on the GZIP phrase on line 83. Should say gziping instead of gzipping (too many p's).

SebastianAigner commented 3 years ago

Thanks Michael - I believe just like “zipping”, “gzipping” would probably have to “p”s. Are there any official sources that spell it “gziping”?

mstephenp commented 3 years ago

Yes - looking it up, the rule overall seems to be if the word ends with a consonant, double it and add "ing", like gzip -> gzipping. So this is technically correct. Maybe what makes it difficult for me is the markdown rendering of gzipping, which makes the additional "p" stand out more.

gzip gzipping gzipping gziping

I think we've wandered out of the scope of normal rules and into some odd territory where we aren't just adding "ing" to a word, but adding it to a markdown quote, which sets it (at least visually) in a different category. As a reader, I don't see "gzipping" but instead "gzip ping".

My feeling in this case is it's probably better to "follow the rules" than to change it based on the visual preferences of one person, so maybe we should just leave this one alone. But I appreciate you considering it!

SebastianAigner commented 3 years ago

Returning to this with fresh eyes, one thing that makes it easier is to get rid of the monospacing. For now, it'll just be "gzipping". Thanks for bringing up this minor eyesore, and providing different considerations!