• 
      

    Cleanup HostingServiceClient documentation & API

    Review Request #8912 — Created April 21, 2017 and submitted

    Information

    Review Board
    release-2.5.x

    Reviewers

    The HostingServiceClient client class as largely undocumented: it
    contained no argument or return type docs. This has been corrected.
    Several of its methods also had mutable defaults, which has been
    replaced with None so that the values do not persist to other calls.
    The _build_form_data method has been made public and static, since it
    should never have to access instance variables to do the serialization
    of the provided data and is a generally useful method outside the class.

    • Ran unit tests.
    • Built the docs and read through them.
    Description From Last Updated

    We may also want to document the standard urlopen exceptions (URLError and HTTPError), here and in the others.

    chipx86chipx86

    Capitalize "The". Same with the docs below.

    chipx86chipx86

    Let's just do: if headers:

    chipx86chipx86

    "HTTP Basic Authentication", here and below.

    chipx86chipx86

    , optional

    chipx86chipx86

    , optional

    chipx86chipx86

    These need to be the full class paths. Same with all below.

    chipx86chipx86

    Got some weirdness going on here.

    chipx86chipx86

    """ on the next line.

    chipx86chipx86
    chipx86
    1. 
        
    2. reviewboard/hostingsvcs/service.py (Diff revision 1)
       
       
       
       
      Show all issues

      We may also want to document the standard urlopen exceptions (URLError and HTTPError), here and in the others.

    3. reviewboard/hostingsvcs/service.py (Diff revision 1)
       
       
       
      Show all issues

      Capitalize "The".

      Same with the docs below.

    4. reviewboard/hostingsvcs/service.py (Diff revision 1)
       
       
      Show all issues

      Let's just do:

      if headers:
      
    5. reviewboard/hostingsvcs/service.py (Diff revision 1)
       
       
      Show all issues

      "HTTP Basic Authentication", here and below.

    6. reviewboard/hostingsvcs/service.py (Diff revision 1)
       
       
      Show all issues

      , optional

    7. reviewboard/hostingsvcs/service.py (Diff revision 1)
       
       
      Show all issues

      , optional

    8. 
        
    brennie
    chipx86
    1. 
        
    2. reviewboard/hostingsvcs/service.py (Diff revision 2)
       
       
       
       
       
      Show all issues

      These need to be the full class paths.

      Same with all below.

    3. reviewboard/hostingsvcs/service.py (Diff revision 2)
       
       
       
       
       
       
       
       
       
      Show all issues

      Got some weirdness going on here.

    4. reviewboard/hostingsvcs/service.py (Diff revision 2)
       
       
      Show all issues

      """ on the next line.

    5. 
        
    brennie
    brennie
    david
    1. Ship It!
    2. 
        
    brennie
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-2.5.x (73a33ef)