Edgewall Software
Modify

Opened 17 years ago

Closed 17 years ago

#6605 closed defect (fixed)

Interface definition of IPreferencePanelProvider appears wrong

Reported by: shansen@… Owned by: Jonas Borgström
Priority: normal Milestone: 0.11
Component: general Version: 0.11b1
Severity: normal Keywords: documentation
Cc: Branch:
Release Notes:
API Changes:
Internal Changes:

Description

The interface definition is listed as, in trac.prefs.api

def render_preference_panel(req, panel, path_info):

But all the actual implementations leave off the path_info argument. Doesn't seem to matter except it confused me when I went and was using the interface definition as documentation :)

Attachments (0)

Change History (3)

comment:1 by Christian Boos, 17 years ago

Keywords: documentation added
Milestone: 0.11

comment:2 by osimons, 17 years ago

Looked at it, and I can't find any usage where we expect that path_info to exists. When first changing it, we should also use the same variable name for 'panel' to make it more intuitive.

  • trac/prefs/api.py

     
    2020        """Return a list of available preference panels.
    2121       
    2222        The items returned by this function must be tuple of the form
    23         `(name, label)`.
     23        `(panel, label)`.
    2424        """
    2525
    26     def render_preference_panel(req, panel, path_info):
     26    def render_preference_panel(req, panel):
    2727        """Process a request for a preference panel.
    2828       
    2929        This function should return a tuple of the form `(template, data)`,

comment:3 by osimons, 17 years ago

Resolution: fixed
Status: newclosed

Applied in [6383].

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Jonas Borgström.
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from Jonas Borgström to the specified user.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.