This repository was archived by the owner on Oct 30, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Oct 30, 2026. It is now read-only.
Linter: function parameters and line breaks #18
Description
When a function declaration uses type hints and needs to break across lines to stay within the character limit, we should have one parameter per line.
e.g.
def foo(self,
bar: int,
baz: str,
qux: typing.Dict[str, typing.List[int]]) -> bool
return True
and not:
def foo(self, bar: int, baz: str,
qux: typing.Dict[str, typing.List[int]]) -> bool
return True
As discussed https://github.com/Shopify/data_bang/pull/97#discussion_r105196063
@erikwright @honkfestival @cfournie does that about sum it up?
Activity
honkfestival commentedon Mar 9, 2017
I might even go so far as to say when it has more than two (2) typed parameters.
JasonMWhite commentedon Mar 9, 2017
I'm ambivalent. @cfournie care to weigh in?
cfournie commentedon Mar 10, 2017
When using the Python 2 function type annotations, matching names to types becomes difficult after two typed parameters and one parameter and comment per line would alleviate that difficulty.
Using the Python 3 annotations I agree more with using one-param per line after 2 types parameters after reading these examples:
erikwright commentedon Mar 10, 2017
Those examples are pretty compelling, @cfournie .
JasonMWhite commentedon Mar 10, 2017
Then we're agreed.