Return better output on webapi doc parse_text failures.

Review Request #4611 — Created Sept. 21, 2013 and submitted

chipx86
Review Board
master
reviewboard

Return better output on webapi doc parse_text failures.

When docs are missing from a class or function, parse_text will fail
accessing a function on a None. That's not useful, and the error output
doesn't tell us what happened or where.

Now, most callers provide a 'where' string that's used for any assertion
messages to better let us know what was missing.

Encountered this problem in another change. This change let me know where
the failure was.

Description From Last Updated

Col: 9 E303 too many blank lines (2)

reviewbotreviewbot
reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    docs/manual/_ext/webapidocs.py
    Ignored Files:

  2. docs/manual/_ext/webapidocs.py (Diff revision 1)
     
     

    Col: 9
    E303 too many blank lines (2)

  3. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    docs/manual/_ext/webapidocs.py
    Ignored Files:

  2. 
      
david
  1. Once you fix ReviewBot's comment, this looks good.

  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Loading...