refactor(admin): update docstrings in backend/apps per review

Author: sukhmancode

backend/apps/owasp/admin/entity_channel.py

@@ -9,7 +9,7 @@
 
 @admin.action(description="Mark selected EntityChannels as reviewed")
 def mark_as_reviewed(_modeladmin, request, queryset):
-   """Mark selected EntityChannel records as reviewed."""
+    """Mark selected EntityChannel records as reviewed."""
     messages.success(
         request,
         f"Marked {queryset.update(is_reviewed=True)} EntityChannel(s) as reviewed.",
@@ -62,8 +62,7 @@ class EntityChannelAdmin(admin.ModelAdmin):
     )
 
     def channel_search_display(self, obj):
-      """Return the display name of the related channel for admin lists."""
-      
+        """Return a readable channel label for admin display."""
         if obj.channel_id and obj.channel_type:
             try:
                 if obj.channel_type.model == "conversation":
@@ -72,24 +71,10 @@ def channel_search_display(self, obj):
             except Conversation.DoesNotExist:
                 return f"Channel {obj.channel_id} (not found)"
         return "-"
-
     channel_search_display.short_description = "Channel Name"
 
     def get_form(self, request, obj=None, **kwargs):
-        """
-        Return the ModelForm class used by the admin for EntityChannel.
-
-        This method also attaches `conversation_content_type_id` to the form
-        class so the admin form can reference the ContentType id for the
-        Conversation model (used client-side or in template logic).
-
-        Args:
-            request (HttpRequest): The current request.
-            obj (EntityChannel | None): The instance being edited (or None for add).
-
-        Returns:
-            Type[ModelForm]: The form class used by this admin.
-        """
+        """Return the admin form with Conversation content type metadata attached."""
         form = super().get_form(request, obj, **kwargs)
         form.conversation_content_type_id = ContentType.objects.get_for_model(Conversation).id
 

backend/apps/owasp/admin/entity_member.py

@@ -13,12 +13,7 @@
 
 
 class EntityMemberAdmin(admin.ModelAdmin):
-    """
-    Admin configuration for EntityMember records.
-
-    EntityMember links a person (Member) to any OWASP entity such as
-    Projects, Chapters, or Committees.
-    """
+    """Admin configuration for EntityMember records. """
 
     actions = ("approve_members",)
     autocomplete_fields = ("member",)
@@ -52,13 +47,7 @@ def approve_members(self, request, queryset):
 
         Sets `is_active=True` and `is_reviewed=True` on all selected records
         and displays a success message showing how many were updated.
-
-        Args:
-            request (HttpRequest): The current request.
-            queryset (QuerySet[EntityMember]): The selected members to approve.
-
-        Returns:
-            None
+        
         """
         self.message_user(
             request,
@@ -71,12 +60,6 @@ def entity(self, obj):
         Return a clickable admin link to the related entity.
 
         Example output: a link to the Project/Chapter/Committee admin change page.
-
-        Args:
-            obj (EntityMember): The EntityMember instance.
-
-        Returns:
-            str: HTML anchor tag or '-' if no entity is assigned.
         """
         return (
             format_html(
@@ -95,12 +78,7 @@ def entity(self, obj):
     def owasp_url(self, obj):
         """
         Return a link to the OWASP site page of the linked entity.
-
-        Args:
-            obj (EntityMember): The EntityMember instance.
-
-        Returns:
-            str: HTML anchor tag linking to the entity’s OWASP page, or '-'.
+        
         """
         return (
             format_html('<a href="{}" target="_blank">↗️</a>', obj.entity.owasp_url)
@@ -118,14 +96,6 @@ def get_search_results(self, request, queryset, search_term):
         - Committee name or key
 
         and includes matching EntityMember rows in the results.
-
-        Args:
-            request (HttpRequest): The current request.
-            queryset (QuerySet): Initial queryset.
-            search_term (str): The text entered in the search field.
-
-        Returns:
-            tuple[QuerySet, bool]: Updated queryset and distinct flag.
         """
         queryset, use_distinct = super().get_search_results(request, queryset, search_term)
 

backend/apps/owasp/admin/member_profile.py

@@ -78,12 +78,6 @@ def get_queryset(self, request):
         This override applies `select_related("github_user")` to reduce the
         number of SQL queries when displaying MemberProfile entries that include
         related GitHub user information.
-
-        Args:
-            request (HttpRequest): The current admin request.
-
-        Returns:
-            QuerySet[MemberProfile]: The optimized queryset with related user data.
         """
         queryset = super().get_queryset(request)
         return queryset.select_related("github_user")

backend/apps/owasp/admin/member_snapshot.py

@@ -114,12 +114,6 @@ def get_queryset(self, request):
         Adds `select_related("github_user")` to reduce SQL queries by fetching
         related GitHub user data in a single query. This improves performance
         when displaying snapshots with user information.
-
-        Args:
-            request (HttpRequest): The current admin request.
-
-        Returns:
-            QuerySet[MemberSnapshot]: Optimized queryset with related user data.
         """
         queryset = super().get_queryset(request)
         return queryset.select_related("github_user")

backend/apps/owasp/admin/mixins.py

@@ -232,14 +232,6 @@ def get_common_config(
     ):
         """
         Build a dictionary of common ModelAdmin configuration values.
-
-        Args:
-            extra_list_display (iterable[str] | None): Additional list_display fields.
-            extra_search_fields (iterable[str] | None): Additional search_fields.
-            extra_list_filters (iterable[str] | None): Additional list_filter fields.
-
-        Returns:
-            dict: A dictionary suitable for unpacking into a ModelAdmin definition.
         """
         config = {}
 

backend/apps/owasp/admin/project.py

@@ -60,12 +60,6 @@ def custom_field_name(self, obj) -> str:
         If the project has a defined `name`, it is shown; otherwise the project
         key is used as a fallback. This ensures that every project row has a
         readable identifier even when optional fields are empty.
-
-        Args:
-            obj (Project): The project instance.
-
-        Returns:
-            str: The readable project label.
         """
         return f"{obj.name or obj.key}"
 

backend/apps/owasp/admin/project_health_metrics.py

@@ -34,12 +34,7 @@ def project(self, obj):
 
         Used in the admin list view to show a readable project label instead
         of the raw project foreign key reference.
-
-        Args:
-            obj (ProjectHealthMetrics): The metrics instance.
-
-        Returns:
-            str: The project name, or "N/A" if no project is assigned.
+        
         """
         return obj.project.name if obj.project else "N/A"
 

backend/apps/slack/admin/member.py

@@ -31,13 +31,7 @@ def approve_suggested_users(self, request, queryset):
         - If exactly one suggested user exists, it is assigned to the Member.
         - If multiple suggested users exist, an error message is returned because only one can be assigned.
         - If none exist, a warning message is shown.
-
-        Args:
-            request (HttpRequest): The current HTTP request.
-            queryset (QuerySet[Member]): The selected Member objects.
-
-        Returns:
-            None
+        
         """
         for entity in queryset:
             suggestions = entity.suggested_users.all()