Skip to content

Commit

Permalink
Add section on formatting
Browse files Browse the repository at this point in the history
Fixes #18
  • Loading branch information
bkaestner committed Aug 21, 2015
1 parent 6f9ca61 commit ce91b74
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion rules/0100-Writing-a-kata.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,34 @@ a _task_. That way, a reader can enjoy the story without all those `x`s ,
`i`s and numbers. Save that for your task.

Essentially use the same kind of language you would like to read in a
published programming book. it is hard to get right, but it is worth the
published programming book. It is hard to get right, but it is worth the
additional time.


Use proper formatting
---------------------

Even with proper grammar and spelling your kata can be hard to read.

Especially if you use arbitrary newlines or code without proper formatting, like

do_something(1) = "Hello world"

or similar. That's not really something your readers enjoy. Instead, use
[proper markdown][GFM].
While it might seem tempting to use plain HTML and CSS, it's not future
proof, as the Codewars style might change. Learning GitHub flavored markdown
doesn't take long so make sure to read it.

Also make sure that your text isn't [ragged] too much.
Getting typographic features right is hard and can take a while. Just play
around with different paragraph lengths, headings and tables. But __always__
format your code. You don't want to have something like the aforementioned
`do_something` in your description.

[GFM]: https://help.github.com/articles/github-flavored-markdown/
[ragged]: https://en.wikipedia.org/wiki/Typographic_alignment

Use the proper types whenever possible
--------------------------------------

Expand Down

0 comments on commit ce91b74

Please sign in to comment.