Opened 9 years ago
Closed 9 years ago
Last modified 6 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|
|Severity:||normal||Keywords:||permissions ExtraPermissionsProvider documentation|
ExtraPermissionsProvider: Added a link to the documentation on the TracIni page from the Component description on the plugin admin page.
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.
Change History (6)
comment:1 by , 9 years ago
|Status:||new → assigned|
comment:2 by , 9 years ago
|Keywords:||permissions ExtraPermissionsProvider documentation added; permission ExteraPermissionsProvider removed|
|Milestone:||0.12.6 → 1.0.2|
Okay, I see now. TracPermissions#CreatingNewPrivileges has been edited. I propose a simple patch to help users navigate to the documentation:
diff --git a/tracopt/perm/config_perm_provider.py b/tracopt/perm/config_perm_pro index 2dfec53..cf2b7fa 100644
a b 1 1 # -*- coding: utf-8 -*- 2 2 # 3 # Copyright (C) 2009 Edgewall Software 3 # Copyright (C) 2009 Edgewall Software 4 4 # All rights reserved. 5 5 # 6 6 # This software is licensed as described in the file COPYING, which … … from trac.perm import IPermissionRequestor 17 17 18 18 19 19 class 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.""" 21 24 22 25 implements(IPermissionRequestor)
comment:3 by , 9 years ago
|Release Notes:||modified (diff)|
|Status:||assigned → closed|
comment:4 by , 9 years ago
I have one other change to propose in response to a question on the mailing list.
For reference, ExtraPermissionsProvider was added in , 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
Proposed changes in log:rjollos.git:t11429.
comment:5 by , 9 years ago
comment:6 by , 6 years ago
Edited ExtraPermissionsProvider@7 and ExtraPermissionsProvider@8 with changes proposed in comment:4.
Minor change in r15359.
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.