diff options
| author | Jake Romer <jkrmr.io@gmail.com> | 2016-08-26 06:12:30 +0000 |
|---|---|---|
| committer | Jake Romer <jkrmr.io@gmail.com> | 2016-08-26 06:12:30 +0000 |
| commit | 1fc0d4f4b50a9aeae73a0b0a9a4641e57786e6b3 (patch) | |
| tree | 78e01c4d0aa1a415757f647c5974d54654764143 | |
| parent | 1bf2fe276ff084d3b2e0860710ec115a317dd9fc (diff) | |
| download | gitlab-ce-1fc0d4f4b50a9aeae73a0b0a9a4641e57786e6b3.tar.gz | |
Clarify blank line rule in newlines_styleguide.md
To clarify what's meant by "from a logical perspective" here, I
consulted Python's PEP8 style guide, which provides some helpfully
precise language:
> Extra blank lines may be used (sparingly) to separate groups of
> related functions. Blank lines may be omitted between a bunch of
> related one-liners (e.g. a set of dummy implementations).
https://www.python.org/dev/peps/pep-0008/#blank-lines
I adapted this passage to the existing language for the newline rule.
| -rw-r--r-- | doc/development/newlines_styleguide.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/development/newlines_styleguide.md b/doc/development/newlines_styleguide.md index e03adcaadea..32aac2529a4 100644 --- a/doc/development/newlines_styleguide.md +++ b/doc/development/newlines_styleguide.md @@ -2,7 +2,7 @@ This style guide recommends best practices for newlines in Ruby code. -## Rule: separate code with newlines only when it makes sense from logic perspectice +## Rule: separate code with newlines only to group together related logic ```ruby # bad |