Make docstrings more consistent using format-webkitpy.

Make docstrings more consistent using format-webkitpy.

Specifically, this CL uses: `./format-webkitpy --leave-strings-alone --no-backups --no-autopep8`.

Committed: https://crrev.com/68218733ac19846dd04c2b7002d50edd13aac5dd
Cr-Commit-Position: refs/heads/master@{#416999}

[qyearsley, 2016-08-17 18:21:40]

Description was changed from

==========
Make docstrings more consistent using format-webkitpy.
==========

to

==========
Make docstrings more consistent using format-webkitpy.

Note, format-webkitpy did the wrong thing and changed strings that weren't
docstrings in three files:

  webkitpy/layout_tests/models/test_expectations_unittest.py
  webkitpy/performance_tests/perftest_unittest.py
  webkitpy/style/main.py

This was caught due to unit test failures.
==========

[qyearsley, 2016-08-17 18:24:09]

Description was changed from

==========
Make docstrings more consistent using format-webkitpy.

Note, format-webkitpy did the wrong thing and changed strings that weren't
docstrings in three files:

  webkitpy/layout_tests/models/test_expectations_unittest.py
  webkitpy/performance_tests/perftest_unittest.py
  webkitpy/style/main.py

This was caught due to unit test failures.
==========

to

==========
Make docstrings more consistent using format-webkitpy.

Note, format-webkitpy did the wrong thing and changed strings that weren't
docstrings in three files:

  webkitpy/layout_tests/models/test_expectations_unittest.py
  webkitpy/performance_tests/perftest_unittest.py
  webkitpy/style/main.py

This was caught due to unit test failures. I inspected the rest of the files to
check for other cases where the auto-formatter didn't behave correctly, and
didn't find any.
==========

[qyearsley, 2016-09-04 19:32:07]

Description was changed from

==========
Make docstrings more consistent using format-webkitpy.

Note, format-webkitpy did the wrong thing and changed strings that weren't
docstrings in three files:

  webkitpy/layout_tests/models/test_expectations_unittest.py
  webkitpy/performance_tests/perftest_unittest.py
  webkitpy/style/main.py

This was caught due to unit test failures. I inspected the rest of the files to
check for other cases where the auto-formatter didn't behave correctly, and
didn't find any.
==========

to

==========
Make docstrings more consistent using format-webkitpy.

Specifically, this CL uses: `./format-webkitpy --leave-strings-alone
--no-backups --no-autopep8`.
==========

[qyearsley, 2016-09-04 19:32:07]

qyearsley@chromium.org changed reviewers:
+ dpranke@chromium.org

[qyearsley, 2016-09-04 19:42:38]

The CQ bit was checked by qyearsley@chromium.org to run a CQ dry run

[commit-bot: I haz the power, 2016-09-04 19:42:41]

Dry run: CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[qyearsley, 2016-09-04 19:42:46]

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
File third_party/WebKit/Tools/Scripts/webkitpy/formatter/fix_docstrings.py
(right):

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
third_party/WebKit/Tools/Scripts/webkitpy/formatter/fix_docstrings.py:38:
node.parent.type == python_symbols.simple_stmt)
After running the formatter on the webkitpy codebase, I found a few cases where
the formatter was incorrectly applied, which were all of the form:

    some_function("""
    some string that's not a docstring
    """)

Unfortunately, I couldn't easily add a test for this that would fail with the
previous code (when the match function was not strict enough); it appears that
the way that the code is parsed in the sample inputs in
formatter/main_unittest.py is different than when it's parsing real Python
source code.

After changing the match function to only match when the parent node type is
simple_stmt, then it appears to work correctly for all code in webkitpy.

[commit-bot: I haz the power, 2016-09-04 20:58:05]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2016-09-04 20:58:06]

Dry run: This issue passed the CQ dry run.

[Dirk Pranke, 2016-09-06 01:14:27]

lgtm, though there are a few cases that seem off ...

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
File third_party/WebKit/Tools/Scripts/webkitpy/common/system/logtesting.py
(right):

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
third_party/WebKit/Tools/Scripts/webkitpy/common/system/logtesting.py:95: """
This indentation seems wrong?

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
File third_party/WebKit/Tools/Scripts/webkitpy/formatter/fix_docstrings.py
(right):

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
third_party/WebKit/Tools/Scripts/webkitpy/formatter/fix_docstrings.py:38:
node.parent.type == python_symbols.simple_stmt)
On 2016/09/04 19:42:46, qyearsley wrote:
> After running the formatter on the webkitpy codebase, I found a few cases
where
> the formatter was incorrectly applied, which were all of the form:
> 
>     some_function("""
>     some string that's not a docstring
>     """)
> 
> Unfortunately, I couldn't easily add a test for this that would fail with the
> previous code (when the match function was not strict enough); it appears that
> the way that the code is parsed in the sample inputs in
> formatter/main_unittest.py is different than when it's parsing real Python
> source code.
> 
> After changing the match function to only match when the parent node type is
> simple_stmt, then it appears to work correctly for all code in webkitpy.

Acknowledged.

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
File
third_party/WebKit/Tools/Scripts/webkitpy/layout_tests/models/test_run_results.py
(right):

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
third_party/WebKit/Tools/Scripts/webkitpy/layout_tests/models/test_run_results.py:183:
"""
another weird case?

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
File third_party/WebKit/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py
(right):

https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
third_party/WebKit/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py:61: """
also weird?

[qyearsley, 2016-09-07 16:34:41]

On 2016/09/06 at 01:14:27, dpranke wrote:
> lgtm, though there are a few cases that seem off ...
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
> File third_party/WebKit/Tools/Scripts/webkitpy/common/system/logtesting.py
(right):
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
> third_party/WebKit/Tools/Scripts/webkitpy/common/system/logtesting.py:95: """
> This indentation seems wrong?
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
> File third_party/WebKit/Tools/Scripts/webkitpy/formatter/fix_docstrings.py
(right):
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
> third_party/WebKit/Tools/Scripts/webkitpy/formatter/fix_docstrings.py:38:
node.parent.type == python_symbols.simple_stmt)
> On 2016/09/04 19:42:46, qyearsley wrote:
> > After running the formatter on the webkitpy codebase, I found a few cases
where
> > the formatter was incorrectly applied, which were all of the form:
> > 
> >     some_function("""
> >     some string that's not a docstring
> >     """)
> > 
> > Unfortunately, I couldn't easily add a test for this that would fail with
the
> > previous code (when the match function was not strict enough); it appears
that
> > the way that the code is parsed in the sample inputs in
> > formatter/main_unittest.py is different than when it's parsing real Python
> > source code.
> > 
> > After changing the match function to only match when the parent node type is
> > simple_stmt, then it appears to work correctly for all code in webkitpy.
> 
> Acknowledged.
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
> File
third_party/WebKit/Tools/Scripts/webkitpy/layout_tests/models/test_run_results.py
(right):
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
>
third_party/WebKit/Tools/Scripts/webkitpy/layout_tests/models/test_run_results.py:183:
"""
> another weird case?
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
> File third_party/WebKit/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py
(right):
> 
>
https://codereview.chromium.org/2256793002/diff/20001/third_party/WebKit/Tool...
> third_party/WebKit/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py:61:
"""
> also weird?

Thanks for taking a closer look -- the reason for the weird end quote
indentation is that previously it was based on the amount of indentation in the
first non-empty line in the docstring after the first line:

  re.search(r'\n( *)\S', node.value).group(1)

It seems like a more generally correct way to do that would have been to use the
parse tree -- if the docstring is indented, then the node.parent.prev_sibling
must always be an indent node, and that can be used. Now fixed and added test.
:-)

[qyearsley, 2016-09-07 16:35:20]

The CQ bit was checked by qyearsley@chromium.org

[qyearsley, 2016-09-07 16:35:20]

The patchset sent to the CQ was uploaded after l-g-t-m from dpranke@chromium.org
Link to the patchset: https://codereview.chromium.org/2256793002/#ps40001
(title: "Make indentation of final quote based on parse tree (indentation prior
to docstring node) rather th…")

[commit-bot: I haz the power, 2016-09-07 16:35:47]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2016-09-07 18:22:08]

Committed patchset #3 (id:40001)

[commit-bot: I haz the power, 2016-09-07 18:24:53]

Description was changed from

==========
Make docstrings more consistent using format-webkitpy.

Specifically, this CL uses: `./format-webkitpy --leave-strings-alone
--no-backups --no-autopep8`.
==========

to

==========
Make docstrings more consistent using format-webkitpy.

Specifically, this CL uses: `./format-webkitpy --leave-strings-alone
--no-backups --no-autopep8`.

Committed: https://crrev.com/68218733ac19846dd04c2b7002d50edd13aac5dd
Cr-Commit-Position: refs/heads/master@{#416999}
==========

[commit-bot: I haz the power, 2016-09-07 18:24:55]

Patchset 3 (id:??) landed as
https://crrev.com/68218733ac19846dd04c2b7002d50edd13aac5dd
Cr-Commit-Position: refs/heads/master@{#416999}