#11429 closed enhancement (fixed)
Add documentation for ExtraPermissionsProvider on the component admin page — at Version 3
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.
Change History (3)
comment:1 by , 10 years ago
Status: | new → assigned |
---|
comment:2 by , 10 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:
-
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 1 1 # -*- coding: utf-8 -*- 2 2 # 3 # Copyright (C) 2009 Edgewall Software3 # Copyright (C) 2009-2013 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 , 10 years ago
Release Notes: | modified (diff) |
---|---|
Resolution: | → fixed |
Status: | assigned → closed |
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.