From 71937a180c1a70e78477319b0742cd88579d02e1 Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 30 May 2022 20:22:58 +0200 Subject: [PATCH] add more docstrings --- InvenTree/common/admin.py | 7 +++++++ InvenTree/common/files.py | 1 + 2 files changed, 8 insertions(+) diff --git a/InvenTree/common/admin.py b/InvenTree/common/admin.py index fa09e5df80..021704615b 100644 --- a/InvenTree/common/admin.py +++ b/InvenTree/common/admin.py @@ -1,3 +1,5 @@ +"""Admin for the common app.""" + from django.contrib import admin from import_export.admin import ImportExportModelAdmin @@ -6,6 +8,7 @@ import common.models class SettingsAdmin(ImportExportModelAdmin): + """Admin settings for InvenTreeSetting.""" list_display = ('key', 'value') @@ -18,6 +21,7 @@ class SettingsAdmin(ImportExportModelAdmin): class UserSettingsAdmin(ImportExportModelAdmin): + """Admin settings for InvenTreeUserSetting.""" list_display = ('key', 'value', 'user', ) @@ -30,16 +34,19 @@ class UserSettingsAdmin(ImportExportModelAdmin): class WebhookAdmin(ImportExportModelAdmin): + """Admin settings for Webhook.""" list_display = ('endpoint_id', 'name', 'active', 'user') class NotificationEntryAdmin(admin.ModelAdmin): + """Admin settings for NotificationEntry.""" list_display = ('key', 'uid', 'updated', ) class NotificationMessageAdmin(admin.ModelAdmin): + """Admin settings for NotificationMessage.""" list_display = ('age_human', 'user', 'category', 'name', 'read', 'target_object', 'source_object', ) diff --git a/InvenTree/common/files.py b/InvenTree/common/files.py index a9326b406e..5a4c5a975c 100644 --- a/InvenTree/common/files.py +++ b/InvenTree/common/files.py @@ -161,6 +161,7 @@ class FileManager: return headers def col_count(self): + """Return the number of columns in the file.""" if self.data is None: return 0