Skip to content

Commit 8d68f1f

Browse files
committed
docs: update docstrings in permission classes to use backticks for code formatting
1 parent ceba0ae commit 8d68f1f

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

openedx_authz/rest_api/v1/permissions.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class BaseScopePermission(BasePermission, metaclass=PermissionMeta):
5252
"""
5353

5454
NAMESPACE = "sc"
55-
"""The namespace identifier for this permission class (default: 'sc' for generic scopes)."""
55+
"""The namespace identifier for this permission class (default: ``sc`` for generic scopes)."""
5656

5757
def get_scope_value(self, request) -> str | None:
5858
"""Extract the scope value from the request.
@@ -128,7 +128,7 @@ class ContentLibraryPermission(BaseScopePermission):
128128
"""
129129

130130
NAMESPACE = "lib"
131-
"""'lib' for content library scopes."""
131+
"""``lib`` for content library scopes."""
132132

133133
def has_permission(self, request, view) -> bool:
134134
"""Check if the user has permission to perform the requested action.
@@ -178,7 +178,7 @@ class DynamicScopePermission(BaseScopePermission):
178178
"""
179179

180180
NAMESPACE = None
181-
"""None (this is a dispatcher, not tied to a specific namespace)."""
181+
"""``None`` (this is a dispatcher, not tied to a specific namespace)."""
182182

183183
def _get_permission_instance(self, request) -> BaseScopePermission:
184184
"""Instantiate the permission class for the request scope.

0 commit comments

Comments
 (0)