Skip to content

Commit

Permalink
Document Maximum Line Length
Browse files Browse the repository at this point in the history
  • Loading branch information
rgaiacs committed Nov 5, 2017
1 parent 64a2856 commit 37adbf3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions _episodes/04-formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ The diagram below shows the internal structure of a single episode file
<img src="{{ page.root }}/fig/episode-format-small.png" alt="Formatting Rules" />
</a>

## Maximum Line Length

Limit all lines to a maximum of 100 characters.
`bin/lesson_check.py` will report lines longer than 100 characters
and this can block your contributions of being accepted.

The two reasons behind the decision to enforce a maximum line lenght are
(1) make diff and merge easier in the command line and other user interfaces
and
(2) make update of translation of the lessons easier.

## Locations and Names

Episode files are stored in `_episodes`
Expand Down

0 comments on commit 37adbf3

Please sign in to comment.