Edgewall Software
Modify

Opened 7 years ago

Closed 7 years ago

Last modified 4 years ago

#11429 closed enhancement (fixed)

Add documentation for ExtraPermissionsProvider on the component admin page

Reported by: Ryan J Ollos Owned by: Ryan J Ollos
Priority: normal Milestone: 1.0.2
Component: general Version:
Severity: normal Keywords: permissions ExtraPermissionsProvider documentation
Cc: Branch:
Release Notes:

ExtraPermissionsProvider: Added a link to the documentation on the TracIni page from the Component description on the plugin admin page.

API Changes:
Internal Changes:

Description

The ExtraPermissionsProvider is documented on t.e.o, but there is no documentation provided with the distribution other than the snippet here: TracPermissions#CreatingNewPrivileges. There, it is stated For more information, please refer to the documentation of the component in the admin panel. However, there is no documentation of the component in the admin panel, so the proposal is to add documentation.

Attachments (0)

Change History (6)

comment:1 by Ryan J Ollos, 7 years ago

Status: newassigned

It seems there is documentation for ExtraPermissionsProvider, but while it is visible on the admin panel in 0.12.6dev, it is not visible in 1.0.2dev.

comment:2 by Ryan J Ollos, 7 years ago

Keywords: permissions ExtraPermissionsProvider documentation added; permission ExteraPermissionsProvider removed
Milestone: 0.12.61.0.2

Okay, I see now. TracPermissions#CreatingNewPrivileges has been edited. I propose a simple patch to help users navigate to the documentation:

  • tracopt/perm/config_perm_provider.py

    diff --git a/tracopt/perm/config_perm_provider.py b/tracopt/perm/config_perm_pro
    index 2dfec53..cf2b7fa 100644
    a b  
    11# -*- coding: utf-8 -*-
    22#
    3 # Copyright (C) 2009 Edgewall Software
     3# Copyright (C) 2009-2013 Edgewall Software
    44# All rights reserved.
    55#
    66# This software is licensed as described in the file COPYING, which
    from trac.perm import IPermissionRequestor  
    1717
    1818
    1919class ExtraPermissionsProvider(Component):
    20     """Extra permission provider."""
     20    """Define arbitrary permissions.
     21
     22    Documentation can be found on the [wiki:TracIni#extra-permissions-section]
     23    page after enabling the component."""
    2124
    2225    implements(IPermissionRequestor)

comment:3 by Ryan J Ollos, 7 years ago

Release Notes: modified (diff)
Resolution: fixed
Status: assignedclosed

Committed to 1.0-stable in [12416] and merged to trunk in [12417].

comment:4 by Ryan J Ollos, 7 years ago

I have one other change to propose in response to a question on the mailing list.

For reference, ExtraPermissionsProvider was added in [8631], but I don't see an associated ticket.

While it makes sense to ignore the casing of the permissions defined in trac.ini, it is a bit confusing to show the example in lowercase given the convention of having upper-case characters for permission names. Therefore the proposed patch changes the example to use upper-case characters and adds a note about the case-insensitivity of the definitions in trac.ini.

Proposed changes in log:rjollos.git:t11429.

comment:5 by Ryan J Ollos, 7 years ago

Change from comment:4 committed to 1.0-stable in [12722], merged to trunk in [12723].

Minor change in r15359.

Version 1, edited 4 years ago by Ryan J Ollos (previous) (next) (diff)

comment:6 by Ryan J Ollos, 4 years ago

Edited ExtraPermissionsProvider@7 and ExtraPermissionsProvider@8 with changes proposed in comment:4.

Minor change in r15359.

Last edited 4 years ago by Ryan J Ollos (previous) (diff)

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Ryan J Ollos.
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from Ryan J Ollos 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.