• 
      

    Add missing documentation for extension hooks

    Review Request #4744 — Created Oct. 14, 2013 and submitted

    Information

    Review Board
    master

    Reviewers

    Add missing documentation for extension hooks

    This change adds docs for the following hooks:
    * ActionHook (and its various subclasses)
    * FileAttachmentThumbnailHook
    * ReviewRequestDetailHook
    * TemplateHook

    I've arranged the hooks documentation alphabetically, since I'm not sure of a
    better way. While I was doing this I noticed a little bit of weirdness in the
    ActionHook init (actions should have been an empty list, not an empty
    dict).

    Generated the HTML docs and checked that things made sense and cross-linked
    correctly.

    Description From Last Updated

    Two blank lines.

    chipx86chipx86

    We have this pattern elsewhere in the docs and examples, but we should change it. We don't really need to …

    chipx86chipx86

    Same here, but this should be passing in self as a parameter.

    chipx86chipx86

    self must be passed as the first parameter.

    chipx86chipx86

    No need to store the hook.

    chipx86chipx86
    chipx86
    1. 
        
    2. docs/manual/users/extending/extensions/hooks.txt (Diff revision 1)
       
       
       
       
      Show all issues

      Two blank lines.

    3. Show all issues

      We have this pattern elsewhere in the docs and examples, but we should change it. We don't really need to store the hook instance ourselves, since it'll happen automatically by instantiating the hook and passing in self.

    4. Show all issues

      Same here, but this should be passing in self as a parameter.

    5. docs/manual/users/extending/extensions/hooks.txt (Diff revision 1)
       
       
       
       
      Show all issues

      self must be passed as the first parameter.

    6. Show all issues

      No need to store the hook.

    7. 
        
    david
    chipx86
    1. Ship It!

    2. 
        
    david
    Review request changed
    Status:
    Completed
    Change Summary:

    Pushed to master (038433e).