Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document line break #134

Closed
rgaiacs opened this issue Oct 17, 2017 · 0 comments
Closed

Document line break #134

rgaiacs opened this issue Oct 17, 2017 · 0 comments
Assignees

Comments

@rgaiacs
Copy link
Contributor

rgaiacs commented Oct 17, 2017

We make a decision to limit lines at 100 characters, see https://github.com/swcarpentry/lesson-example/blob/gh-pages/bin/lesson_check.py#L100. But this must be documented at http://swcarpentry.github.io/lesson-example/04-formatting/ including rules of how to setup your text editor.

Why limit the length of lines?

The main motivation is to help when translating the lesson, although translations is yet in-progress (see https://github.com/Carpentries-ES/board/). Short lines will speed up when we update the translations because conflicts will be easier to resolve.

Conflicts also happen when merging some pull requests but doesn't happen often.

Related Issues/Pull Request

swcarpentry/shell-novice#639

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant