Skip to content

Commit

Permalink
cleanup plugin member docstrings (#1296)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikkonie committed Nov 21, 2023
1 parent 102a3a0 commit 5e8d27d
Show file tree
Hide file tree
Showing 13 changed files with 39 additions and 29 deletions.
4 changes: 2 additions & 2 deletions adminalerts/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@
class SiteAppPlugin(SiteAppPluginPoint):
"""Projectroles plugin for registering the app"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'adminalerts'

#: Title (used in templates)
title = 'Admin Alerts'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urlpatterns

#: Iconify icon
Expand Down
6 changes: 3 additions & 3 deletions appalerts/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
class SiteAppPlugin(SiteAppPluginPoint):
"""Site plugin for application alerts"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'appalerts'

#: Title (used in templates)
title = 'App Alerts'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urlpatterns

#: Iconify icon
Expand All @@ -36,7 +36,7 @@ class SiteAppPlugin(SiteAppPluginPoint):
class BackendPlugin(BackendPluginPoint):
"""Backend plugin for application alerts"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'appalerts_backend'

#: Title (used in templates)
Expand Down
9 changes: 7 additions & 2 deletions bgjobs/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,13 @@
class ProjectAppPlugin(ProjectAppPluginPoint):
"""Plugin for registering app with Projectroles"""

#: Name (used as plugin ID)
name = 'bgjobs'

#: Title (used in templates)
title = 'Background Jobs'

#: UI URLs
urls = urls_ui_project

#: Iconify icon
Expand Down Expand Up @@ -61,13 +66,13 @@ class BackgroundJobsPluginPoint(PluginPoint):
class SiteAppPlugin(SiteAppPluginPoint):
"""Projectroles plugin for registering the app"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'bgjobs_site'

#: Title (used in templates)
title = 'Site Background Jobs'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urls_ui_site

#: Iconify icon
Expand Down
2 changes: 1 addition & 1 deletion example_backend_app/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
class BackendPlugin(BackendPluginPoint):
"""Plugin for registering backend app with Projectroles"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'example_backend_app'

#: Title (used in templates)
Expand Down
4 changes: 2 additions & 2 deletions example_project_app/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ class ProjectAppPlugin(ProjectModifyPluginMixin, ProjectAppPluginPoint):

# Properties required by django-plugins ------------------------------

#: Name (slug-safe)
#: Name (used as plugin ID)
name = 'example_project_app'

#: Title (used in templates)
title = 'Example Project App'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urlpatterns

# Properties defined in ProjectAppPluginPoint -----------------------
Expand Down
4 changes: 2 additions & 2 deletions example_site_app/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
class SiteAppPlugin(SiteAppPluginPoint):
"""Projectroles plugin for registering the app"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'example_site_app'

#: Title (used in templates)
title = 'Example Site App'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urlpatterns

#: Iconify icon
Expand Down
4 changes: 2 additions & 2 deletions filesfolders/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ class ProjectAppPlugin(ProjectAppPluginPoint):

# Properties required by django-plugins ------------------------------

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'filesfolders'

#: Title (used in templates)
title = 'Files'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urlpatterns

# Properties defined in ProjectAppPluginPoint -----------------------
Expand Down
6 changes: 3 additions & 3 deletions projectroles/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ def revert_project_archive(
class ProjectAppPluginPoint(PluginPoint):
"""Projectroles plugin point for registering project specific apps"""

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = []

#: App settings definition
Expand Down Expand Up @@ -746,13 +746,13 @@ def get_backend_api(plugin_name, force=False, **kwargs):
class RemoteSiteAppPlugin(SiteAppPluginPoint):
"""Site plugin for remote site and project management"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'remotesites'

#: Title (used in templates)
title = 'Remote Site Access'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = []

#: Iconify icon
Expand Down
4 changes: 2 additions & 2 deletions siteinfo/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
class SiteAppPlugin(SiteAppPluginPoint):
"""Projectroles plugin for registering the app"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'siteinfo'

#: Title (used in templates)
title = 'Site Info'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urlpatterns

#: Iconify icon
Expand Down
2 changes: 1 addition & 1 deletion sodarcache/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
class BackendPlugin(BackendPluginPoint):
"""Plugin for registering backend app with Projectroles"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'sodar_cache'

#: Title (used in templates)
Expand Down
14 changes: 7 additions & 7 deletions timeline/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ class ProjectAppPlugin(ProjectAppPluginPoint):

# Properties required by django-plugins ------------------------------

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'timeline'

#: Title (used in templates)
title = 'Timeline'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urls_ui_project

# Properties defined in ProjectAppPluginPoint -----------------------
Expand Down Expand Up @@ -124,7 +124,7 @@ def search(self, search_terms, user, search_type=None, keywords=None):
class BackendPlugin(BackendPluginPoint):
"""Plugin for registering backend app with Projectroles"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'timeline_backend'

#: Title (used in templates)
Expand All @@ -144,13 +144,13 @@ def get_api(self, **kwargs):
class SiteAppPlugin(SiteAppPluginPoint):
"""Projectroles plugin for registering the app"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'timeline_site'

#: Title (used in templates)
title = 'Site-Wide Events'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urls_ui_site

#: Iconify icon
Expand All @@ -169,13 +169,13 @@ class SiteAppPlugin(SiteAppPluginPoint):
class AdminSiteAppPlugin(SiteAppPluginPoint):
"""Projectroles plugin for registering the app"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'timeline_site_admin'

#: Title (used in templates)
title = 'All Timeline Events'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urls_ui_admin

#: Iconify icon
Expand Down
5 changes: 5 additions & 0 deletions tokens/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,22 @@
class ProjectAppPlugin(SiteAppPluginPoint):
"""Plugin for registering app with Projectroles"""

#: Name (used as plugin ID)
name = 'tokens'

#: Title (used in templates)
title = 'API Tokens'

#: UI URLs
urls = urlpatterns

#: Iconify icon
icon = 'mdi:key-chain-variant'

#: Entry point URL ID
entry_point_url_id = 'tokens:list'

#: Description string
description = 'API Token Management'

#: Required permission for accessing the app
Expand Down
4 changes: 2 additions & 2 deletions userprofile/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
class SiteAppPlugin(SiteAppPluginPoint):
"""Projectroles plugin for registering the app"""

#: Name (slug-safe, used in URLs)
#: Name (used as plugin ID)
name = 'userprofile'

#: Title (used in templates)
title = 'User Profile'

#: App URLs (will be included in settings by djangoplugins)
#: UI URLs
urls = urlpatterns

#: Iconify icon
Expand Down

0 comments on commit 5e8d27d

Please sign in to comment.