From fd81304fc8b077a99a1f3be7ff3c5df11c618cf1 Mon Sep 17 00:00:00 2001 From: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com> Date: Tue, 21 Jul 2026 17:19:35 -0700 Subject: [PATCH] docs: update docstrings --- src/tagstudio/qt/controllers/field_suggest_box.py | 6 ++---- src/tagstudio/qt/controllers/preview_panel_controller.py | 1 - src/tagstudio/qt/controllers/suggest_box.py | 1 - src/tagstudio/qt/controllers/tag_suggest_box.py | 6 ++---- src/tagstudio/qt/controllers/underlined_widget.py | 1 - 5 files changed, 4 insertions(+), 11 deletions(-) diff --git a/src/tagstudio/qt/controllers/field_suggest_box.py b/src/tagstudio/qt/controllers/field_suggest_box.py index 99b1c9f4..a0c7380e 100644 --- a/src/tagstudio/qt/controllers/field_suggest_box.py +++ b/src/tagstudio/qt/controllers/field_suggest_box.py @@ -49,12 +49,10 @@ class FieldSuggestBox(SuggestBox[BaseFieldTemplate]): @override def _on_item_create(self) -> None: - """Opens panel to create a new field template and optionally add it to an entry. + """Creates a new field template and adds it to the currently selected entries. + Optionally opens up an edit panel after creation and before adding to entries. Populates name field using current search query. - - Args: - add_to_entry (bool): Should this item be added to currently selected entries? """ # NOTE: Unlike tags, creating new field templates will ALWAYS spawn an edit window # since the user needs to decide what type of field it should be before it's created. diff --git a/src/tagstudio/qt/controllers/preview_panel_controller.py b/src/tagstudio/qt/controllers/preview_panel_controller.py index 638b0ca8..4de14e41 100644 --- a/src/tagstudio/qt/controllers/preview_panel_controller.py +++ b/src/tagstudio/qt/controllers/preview_panel_controller.py @@ -278,5 +278,4 @@ class PreviewPanel(QWidget): @override def layout(self) -> PreviewPanelView: - """Return the typed layout for this widget.""" return super().layout() # pyright: ignore[reportReturnType] diff --git a/src/tagstudio/qt/controllers/suggest_box.py b/src/tagstudio/qt/controllers/suggest_box.py index 30dc62c8..1f80ff4e 100644 --- a/src/tagstudio/qt/controllers/suggest_box.py +++ b/src/tagstudio/qt/controllers/suggest_box.py @@ -216,7 +216,6 @@ class SuggestBox[T](QWidget): @override def layout(self) -> SuggestBoxView: - """Return the typed layout for this widget.""" return super().layout() # pyright: ignore[reportReturnType] @override diff --git a/src/tagstudio/qt/controllers/tag_suggest_box.py b/src/tagstudio/qt/controllers/tag_suggest_box.py index c74117ea..d0db7d04 100644 --- a/src/tagstudio/qt/controllers/tag_suggest_box.py +++ b/src/tagstudio/qt/controllers/tag_suggest_box.py @@ -57,12 +57,10 @@ class TagSuggestBox(SuggestBox[Tag]): @override def _on_item_create(self) -> None: - """Opens panel to create a new tag and optionally add it to an entry. + """Creates a new tag and adds it to the currently selected entries. + Optionally opens up an edit panel after creation and before adding to entries. Populates name field using current search query. - - Args: - add_to_entry (bool): Should this item be added to currently selected entries? """ query: str = self.layout().search_field.text() diff --git a/src/tagstudio/qt/controllers/underlined_widget.py b/src/tagstudio/qt/controllers/underlined_widget.py index 46291997..fe86de6d 100644 --- a/src/tagstudio/qt/controllers/underlined_widget.py +++ b/src/tagstudio/qt/controllers/underlined_widget.py @@ -23,5 +23,4 @@ class UnderlinedWidget(QWidget): @override def layout(self) -> UnderlinedWidgetView: - """Return the typed layout for this widget.""" return super().layout() # pyright: ignore[reportReturnType]