| 1 |
On 02/20/2014 02:58 AM, Alexander Berntsen wrote: |
| 2 |
> On 20/02/14 01:08, Pavel Kazakov wrote: |
| 3 |
>>> """Scan for failed merges fix them.""" |
| 4 |
>> All the other modules put the second """ on a newline, so I |
| 5 |
>> wanted to be consistent. Should I still make the change? |
| 6 |
> What the other modules are doing is not necessarily an indication |
| 7 |
> of what we should do. More often than not, they are the opposite |
| 8 |
> of what we should do, and following them because "hey it might be |
| 9 |
> terrible, but at least it's consistently terrible" isn't fruitful. |
| 10 |
> So I agree with Alec. |
| 11 |
> |
| 12 |
> If you want consistency, feel free to fix the other docstrings. |
| 13 |
> ;-) |
| 14 |
|
| 15 |
I agree that consistency for its own sake, if dealing with bad code, |
| 16 |
isn't very fruitful, but I do think consistency matters when dealing |
| 17 |
with style conventions. As far as I can tell, having """ on a newline |
| 18 |
is purely a style choice and doesn't have any impact on how the code |
| 19 |
functions. So for cases where style might be ambiguous, I choose |
| 20 |
what's already there. |
| 21 |
|
| 22 |
You could argue that PEP 257 recommends having a one-liner include the |
| 23 |
""" on the same line, but the portage project doesn't exactly follow |
| 24 |
all PEPs anyway ;) |
| 25 |
|
| 26 |
Regards, |
| 27 |
Pavel |
Archives