Reduce docstring line lengths for webapi unit tests.

Review Request #4585 — Created Sept. 17, 2013 and submitted

chipx86
Review Board
master
reviewboard

Reduce docstring line lengths for webapi unit tests.

An annoying thing about submitting webapi unit test code for review is
that ReviewBot would be very sad about the docstring line lengths. These
were long because unit tests, by default, only show the first line.
However, that's under our control, it turns out.

Now, the new base TestCase will grab the summary, even if it's wrapped
across lines, and turn it into one line.

All the docstrings have been updated in the webapi tests for this. The
rules I used for formatting them is as follows:

1) If it can fit on one line, then keep it on one line.
2) If it needs to wrap, wrap the details part after "API" (such as
"with ...") on the next line.
3) If it still needs to wrap, wrap the "METHOD URL API" part onto its
own line, keeping it together as much as possible.
4) If it still needs to wrap, break that part up as needed.

Some URLs are long enough by themselves where they will still trigger
warnings, but this is limited to only a few instances now.

Unit tests pass, and look correct.

Description From Last Updated

'TestTool' imported but unused

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (85 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (85 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (85 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (85 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot

Col: 80 E501 line too long (80 > 79 characters)

reviewbotreviewbot
reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    reviewboard/webapi/tests/test_review_reply_screenshot_comment.py
    reviewboard/webapi/tests/test_review_screenshot_comment.py
    reviewboard/webapi/tests/test_file_diff_comment.py
    reviewboard/webapi/tests/test_watched_review_request.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/tests/test_default_reviewer.py
    reviewboard/webapi/tests/test_draft_review_screenshot_comment.py
    reviewboard/webapi/tests/test_screenshot.py
    reviewboard/webapi/tests/test_repository_commits.py
    reviewboard/webapi/tests/test_review_comment.py
    reviewboard/webapi/tests/test_review_group.py
    reviewboard/webapi/tests/test_file_attachment_draft.py
    reviewboard/webapi/tests/test_change.py
    reviewboard/webapi/tests/test_review_reply.py
    reviewboard/webapi/tests/test_file_attachment_comment.py
    reviewboard/webapi/tests/test_server_info.py
    reviewboard/webapi/tests/test_repository_branches.py
    reviewboard/webapi/tests/test_user.py
    reviewboard/testing/testcase.py
    reviewboard/webapi/tests/test_screenshot_comment.py
    reviewboard/webapi/tests/test_session.py
    reviewboard/webapi/tests/test_watched_review_group.py
    reviewboard/webapi/tests/test_review_request.py
    reviewboard/webapi/tests/test_review_request_draft.py
    reviewboard/webapi/tests/test_draft_review_file_attachment_comment.py
    reviewboard/webapi/tests/test_diff.py
    reviewboard/webapi/tests/test_repository.py
    reviewboard/webapi/tests/test_validate_diff.py
    reviewboard/webapi/tests/test_file_attachment.py
    reviewboard/webapi/tests/test_review_reply_file_attachment_comment.py
    reviewboard/webapi/tests/test_review_group_user.py
    reviewboard/webapi/tests/test_repository_info.py
    reviewboard/webapi/tests/test_review_reply_diff_comment.py
    reviewboard/webapi/tests/test_screenshot_draft.py
    Ignored Files:

  2. Col: 80
    E501 line too long (80 > 79 characters)

  3. Col: 80
    E501 line too long (80 > 79 characters)

  4. Col: 80
    E501 line too long (80 > 79 characters)

  5. Col: 80
    E501 line too long (80 > 79 characters)

  6. Col: 80
    E501 line too long (80 > 79 characters)

  7. Col: 80
    E501 line too long (85 > 79 characters)

  8. Col: 80
    E501 line too long (85 > 79 characters)

  9. Col: 80
    E501 line too long (85 > 79 characters)

  10. Col: 80
    E501 line too long (85 > 79 characters)

  11. Col: 80
    E501 line too long (80 > 79 characters)

  12. Col: 80
    E501 line too long (80 > 79 characters)

  13. Col: 80
    E501 line too long (80 > 79 characters)

  14. Col: 80
    E501 line too long (80 > 79 characters)

  15. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    reviewboard/webapi/tests/test_review_reply_screenshot_comment.py
    reviewboard/webapi/tests/test_review_screenshot_comment.py
    reviewboard/webapi/tests/test_file_diff_comment.py
    reviewboard/webapi/tests/test_watched_review_request.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/tests/test_default_reviewer.py
    reviewboard/webapi/tests/test_draft_review_screenshot_comment.py
    reviewboard/webapi/tests/test_screenshot.py
    reviewboard/webapi/tests/test_repository_commits.py
    reviewboard/webapi/tests/test_review_comment.py
    reviewboard/webapi/tests/test_review_group.py
    reviewboard/webapi/tests/test_file_attachment_draft.py
    reviewboard/webapi/tests/test_change.py
    reviewboard/webapi/tests/test_review_reply.py
    reviewboard/webapi/tests/test_file_attachment_comment.py
    reviewboard/webapi/tests/test_server_info.py
    reviewboard/webapi/tests/test_repository_branches.py
    reviewboard/webapi/tests/test_user.py
    reviewboard/testing/testcase.py
    reviewboard/webapi/tests/test_screenshot_comment.py
    reviewboard/webapi/tests/test_session.py
    reviewboard/webapi/tests/test_watched_review_group.py
    reviewboard/webapi/tests/test_review_request.py
    reviewboard/webapi/tests/test_review_request_draft.py
    reviewboard/webapi/tests/test_draft_review_file_attachment_comment.py
    reviewboard/webapi/tests/test_diff.py
    reviewboard/webapi/tests/test_repository.py
    reviewboard/webapi/tests/test_validate_diff.py
    reviewboard/webapi/tests/test_file_attachment.py
    reviewboard/webapi/tests/test_review_reply_file_attachment_comment.py
    reviewboard/webapi/tests/test_review_group_user.py
    reviewboard/webapi/tests/test_repository_info.py
    reviewboard/webapi/tests/test_review_reply_diff_comment.py
    reviewboard/webapi/tests/test_screenshot_draft.py
    Ignored Files:

  2. reviewboard/webapi/tests/test_diff.py (Diff revision 1)
     
     

    'TestTool' imported but unused

  3. 
      
david
  1. Ship It!

  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Loading...