From 0b4a6b14e7ffaab3db09c8064beed81eb830aa57 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:25:55 +0200 Subject: [PATCH 01/89] Fix pydoclint errors in ui/screens/operations/governance_operations/proxy/proxy.py.Proxy --- .../operations/governance_operations/proxy/proxy.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/operations/governance_operations/proxy/proxy.py b/clive/__private/ui/screens/operations/governance_operations/proxy/proxy.py index c12be107d6..aadf0b6c48 100644 --- a/clive/__private/ui/screens/operations/governance_operations/proxy/proxy.py +++ b/clive/__private/ui/screens/operations/governance_operations/proxy/proxy.py @@ -72,7 +72,12 @@ class ProxySet(ProxyBaseContainer): class Proxy(TabPane, CliveWidget): - """TabPane with all content about proxy.""" + """ + TabPane with all content about proxy. + + Attributes: + DEFAULT_CSS: Default CSS for the proxy tab pane. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 04df7ec77a..5d7bb68dc3 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -405,10 +405,6 @@ clive/__private/ui/screens/operations/governance_operations/common_governance/go DOC103: Method `GovernanceListWidget._create_row`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [data: GovernanceDataT, even: bool]. DOC201: Method `GovernanceListWidget._create_row` does not have a return section in docstring -------------------- -clive/__private/ui/screens/operations/governance_operations/proxy/proxy.py - DOC601: Class `Proxy`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `Proxy`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/operations/governance_operations/witness/witness.py DOC101: Method `WitnessNameLabel.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `WitnessNameLabel.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [classes: str, witness_name: str]. -- GitLab From 0753af23e212a5c835a7cc7f5e15bb9ad27d1e0d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:27:31 +0200 Subject: [PATCH 02/89] Fix pydoclint errors in ui/screens/operations/governance_operations/witness/witness.py.WitnessNameLabel --- .../operations/governance_operations/witness/witness.py | 8 +++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/screens/operations/governance_operations/witness/witness.py b/clive/__private/ui/screens/operations/governance_operations/witness/witness.py index c13c3c0ab7..26e277dfae 100644 --- a/clive/__private/ui/screens/operations/governance_operations/witness/witness.py +++ b/clive/__private/ui/screens/operations/governance_operations/witness/witness.py @@ -67,7 +67,13 @@ class WitnessDetailsLabel(Label): class WitnessNameLabel(Label, CliveWidget): - """Label with witness name.""" + """ + Label with witness name. + + Args: + witness_name: Name of the witness to be displayed. + classes: Optional CSS classes for the label. + """ def __init__(self, witness_name: str, classes: str) -> None: super().__init__( diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 5d7bb68dc3..9366819fd4 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -406,8 +406,6 @@ clive/__private/ui/screens/operations/governance_operations/common_governance/go DOC201: Method `GovernanceListWidget._create_row` does not have a return section in docstring -------------------- clive/__private/ui/screens/operations/governance_operations/witness/witness.py - DOC101: Method `WitnessNameLabel.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `WitnessNameLabel.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [classes: str, witness_name: str]. DOC601: Class `Witness`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `Witness`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [BINDINGS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `Search`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From c07dfe470b08a137504f69398742f7058cd3cf50 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:34:11 +0200 Subject: [PATCH 03/89] Fix pydoclint errors in ui/screens/operations/governance_operations/witness/witness.py.WitnessManualSearch.Search --- .../governance_operations/witness/witness.py | 15 +++++++++++++-- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/clive/__private/ui/screens/operations/governance_operations/witness/witness.py b/clive/__private/ui/screens/operations/governance_operations/witness/witness.py index 26e277dfae..602bbd1748 100644 --- a/clive/__private/ui/screens/operations/governance_operations/witness/witness.py +++ b/clive/__private/ui/screens/operations/governance_operations/witness/witness.py @@ -84,7 +84,12 @@ class WitnessNameLabel(Label, CliveWidget): class Witness(GovernanceTableRow[WitnessData]): - """Check if there is a witness in the action table - if so, move True to the WitnessCheckbox parameter.""" + """ + Check if there is a witness in the action table - if so, move True to the witness checkbox parameter. + + Attributes: + BINDINGS: List of predefined bindings for the witness row. + """ BINDINGS = [CLIVE_PREDEFINED_BINDINGS.operations.witness_show_details.create(description="Details")] @@ -128,7 +133,13 @@ class WitnessManualSearch(Grid): @dataclass class Search(Message): - """Emitted when the search button is pressed.""" + """ + Emitted when the search button is pressed. + + Attributes: + pattern: The pattern to search for in witness names. + limit: The maximum number of witnesses to return. + """ pattern: str limit: int diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 9366819fd4..8c14c24d3e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -406,10 +406,6 @@ clive/__private/ui/screens/operations/governance_operations/common_governance/go DOC201: Method `GovernanceListWidget._create_row` does not have a return section in docstring -------------------- clive/__private/ui/screens/operations/governance_operations/witness/witness.py - DOC601: Class `Witness`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `Witness`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [BINDINGS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC601: Class `Search`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `Search`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [limit: int, pattern: str]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `Witnesses`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `Witnesses`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `Witnesses._create_operation`: Docstring contains fewer arguments than in function signature. -- GitLab From dfc4d79ad44ac5d926834a0f0cf7f8e7dec6cd8f Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:34:52 +0200 Subject: [PATCH 04/89] Fix pydoclint errors in ui/screens/operations/governance_operations/witness/witness.py.Witnesses --- .../operations/governance_operations/witness/witness.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/screens/operations/governance_operations/witness/witness.py b/clive/__private/ui/screens/operations/governance_operations/witness/witness.py index 602bbd1748..5945e9536f 100644 --- a/clive/__private/ui/screens/operations/governance_operations/witness/witness.py +++ b/clive/__private/ui/screens/operations/governance_operations/witness/witness.py @@ -268,7 +268,12 @@ class WitnessesTable(GovernanceTable[WitnessData, WitnessesDataProvider]): class Witnesses(GovernanceTabPane): - """TabPane with all content about witnesses.""" + """ + TabPane with all content about witnesses. + + Attributes: + DEFAULT_CSS: Default CSS for the witnesses tab pane. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 8c14c24d3e..5237f400e9 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -406,8 +406,6 @@ clive/__private/ui/screens/operations/governance_operations/common_governance/go DOC201: Method `GovernanceListWidget._create_row` does not have a return section in docstring -------------------- clive/__private/ui/screens/operations/governance_operations/witness/witness.py - DOC601: Class `Witnesses`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `Witnesses`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `Witnesses._create_operation`: Docstring contains fewer arguments than in function signature. DOC103: Method `Witnesses._create_operation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [vote: bool, witness: str]. DOC201: Method `Witnesses._create_operation` does not have a return section in docstring -- GitLab From 1478265be8cfc3aa09d234a61bff0fa3337ad92e Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:36:21 +0200 Subject: [PATCH 05/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/common_hive_power/additional_info_widgets.py.WithdrawalInfo --- .../common_hive_power/additional_info_widgets.py | 10 +++++++++- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/common_hive_power/additional_info_widgets.py b/clive/__private/ui/screens/operations/hive_power_management/common_hive_power/additional_info_widgets.py index 3bca78a241..5aa443c161 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/common_hive_power/additional_info_widgets.py +++ b/clive/__private/ui/screens/operations/hive_power_management/common_hive_power/additional_info_widgets.py @@ -24,7 +24,15 @@ if TYPE_CHECKING: class WithdrawalInfo(Vertical, CliveWidget): - """Widget that displays all withdrawal information.""" + """ + Widget that displays all withdrawal information. + + Attributes: + DEFAULT_CSS: Default CSS for the withdrawal info widget. + + Args: + provider: Data provider that provides the data for the widget. + """ DEFAULT_CSS = """ WithdrawalInfo { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 5237f400e9..4ad296b514 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -410,12 +410,6 @@ clive/__private/ui/screens/operations/governance_operations/witness/witness.py DOC103: Method `Witnesses._create_operation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [vote: bool, witness: str]. DOC201: Method `Witnesses._create_operation` does not have a return section in docstring -------------------- -clive/__private/ui/screens/operations/hive_power_management/common_hive_power/additional_info_widgets.py - DOC601: Class `WithdrawalInfo`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `WithdrawalInfo`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `WithdrawalInfo.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `WithdrawalInfo.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [provider: HivePowerDataProvider]. --------------------- clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py DOC601: Class `DelegationsTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `DelegationsTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 5c07eeabd3f4d8293dd54a30e92e8619bd9af11a Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:37:39 +0200 Subject: [PATCH 06/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py.DelegationsTable --- .../delegate_hive_power/delegate_hive_power.py | 8 +++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py b/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py index de4629d571..0cf71f735e 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py +++ b/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py @@ -70,7 +70,13 @@ class Delegation(CliveCheckerboardTableRow): class DelegationsTable(CliveCheckerboardTable): - """Table with delegations.""" + """ + Table with delegations. + + Attributes: + ATTRIBUTE_TO_WATCH: Attribute to watch for changes. + NO_CONTENT_TEXT: Text to display when there are no delegations. + """ ATTRIBUTE_TO_WATCH = "_content" NO_CONTENT_TEXT = "You have no delegations" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 4ad296b514..e625ff9d64 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -411,8 +411,6 @@ clive/__private/ui/screens/operations/governance_operations/witness/witness.py DOC201: Method `Witnesses._create_operation` does not have a return section in docstring -------------------- clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py - DOC601: Class `DelegationsTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `DelegationsTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `DelegateHivePower`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `DelegateHivePower`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -------------------- -- GitLab From 6a4a4d59e0cb86c2d8fb810cb80bd00435fea32d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:38:09 +0200 Subject: [PATCH 07/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py.DelegateHivePower --- .../delegate_hive_power/delegate_hive_power.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py b/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py index 0cf71f735e..1bf0e6ad08 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py +++ b/clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py @@ -108,7 +108,12 @@ class DelegationsTable(CliveCheckerboardTable): class DelegateHivePower(TabPane, OperationActionBindings): - """TabPane with all content about delegate hp.""" + """ + TabPane with all content about delegate hp. + + Attributes: + DEFAULT_CSS: Default CSS for tab pane. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index e625ff9d64..d5d0fd367a 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -410,10 +410,6 @@ clive/__private/ui/screens/operations/governance_operations/witness/witness.py DOC103: Method `Witnesses._create_operation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [vote: bool, witness: str]. DOC201: Method `Witnesses._create_operation` does not have a return section in docstring -------------------- -clive/__private/ui/screens/operations/hive_power_management/delegate_hive_power/delegate_hive_power.py - DOC601: Class `DelegateHivePower`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `DelegateHivePower`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/operations/hive_power_management/power_down/power_down.py DOC101: Method `WithdrawRoutesDisplay._update_withdraw_routes`: Docstring contains fewer arguments than in function signature. DOC103: Method `WithdrawRoutesDisplay._update_withdraw_routes`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: HivePowerData | NotUpdatedYet]. -- GitLab From b053e394e9ecf694b016372657c62455d5dbaf4f Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:40:15 +0200 Subject: [PATCH 08/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/power_down/power_down.py.PowerDown --- .../hive_power_management/power_down/power_down.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/power_down/power_down.py b/clive/__private/ui/screens/operations/hive_power_management/power_down/power_down.py index 93dc45ec39..90aed22a44 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/power_down/power_down.py +++ b/clive/__private/ui/screens/operations/hive_power_management/power_down/power_down.py @@ -129,7 +129,12 @@ class PendingPowerDown(CliveCheckerboardTable): class PowerDown(TabPane, OperationActionBindings): - """TabPane with all content about power down.""" + """ + TabPane with all content about power down. + + Attributes: + DEFAULT_CSS: Default CSS for the tab pane. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index d5d0fd367a..e251d586ea 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -413,8 +413,6 @@ clive/__private/ui/screens/operations/governance_operations/witness/witness.py clive/__private/ui/screens/operations/hive_power_management/power_down/power_down.py DOC101: Method `WithdrawRoutesDisplay._update_withdraw_routes`: Docstring contains fewer arguments than in function signature. DOC103: Method `WithdrawRoutesDisplay._update_withdraw_routes`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: HivePowerData | NotUpdatedYet]. - DOC601: Class `PowerDown`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `PowerDown`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC201: Method `PowerDown._calculate_one_withdrawal` does not have a return section in docstring -------------------- clive/__private/ui/screens/operations/hive_power_management/power_up/power_up.py -- GitLab From 6e184cb166af8b24925e52b42badc5376922fd98 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:41:27 +0200 Subject: [PATCH 09/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/power_up/power_up.py.PowerUp --- .../operations/hive_power_management/power_up/power_up.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/power_up/power_up.py b/clive/__private/ui/screens/operations/hive_power_management/power_up/power_up.py index 139cfd4b39..c7c37bf7f3 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/power_up/power_up.py +++ b/clive/__private/ui/screens/operations/hive_power_management/power_up/power_up.py @@ -24,7 +24,12 @@ if TYPE_CHECKING: class PowerUp(TabPane, OperationActionBindings): - """TabPane with all content about power up.""" + """ + TabPane with all content about power up. + + Attributes: + DEFAULT_CSS: Default CSS for the power up screen. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index e251d586ea..3135722f84 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -415,10 +415,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow DOC103: Method `WithdrawRoutesDisplay._update_withdraw_routes`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: HivePowerData | NotUpdatedYet]. DOC201: Method `PowerDown._calculate_one_withdrawal` does not have a return section in docstring -------------------- -clive/__private/ui/screens/operations/hive_power_management/power_up/power_up.py - DOC601: Class `PowerUp`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `PowerUp`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py DOC601: Class `WithdrawRoutesTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `WithdrawRoutesTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 71060738023138a970070fc70100816a59e112ad Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:43:13 +0200 Subject: [PATCH 10/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py.WithdrawRoutesTable --- .../withdraw_routes/withdraw_routes.py | 8 +++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py index 902e1a1a4d..1c32e489c4 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py +++ b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py @@ -71,7 +71,13 @@ class WithdrawRoute(CliveCheckerboardTableRow): class WithdrawRoutesTable(CliveCheckerboardTable): - """Table with WithdrawRoutes.""" + """ + Table with WithdrawRoutes. + + Attributes: + ATTRIBUTE_TO_WATCH: Attribute of the HivePowerDataProvider to watch for updates. + NO_CONTENT_TEXT: Text to display when there are no withdraw routes. + """ ATTRIBUTE_TO_WATCH = "_content" NO_CONTENT_TEXT = "You have no withdraw routes" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 3135722f84..b035a16468 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -416,8 +416,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow DOC201: Method `PowerDown._calculate_one_withdrawal` does not have a return section in docstring -------------------- clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py - DOC601: Class `WithdrawRoutesTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `WithdrawRoutesTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `WithdrawRoutes`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `WithdrawRoutes`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_AUTO_VEST: Final[bool], DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -------------------- -- GitLab From 8a06fc2188e1bd25dedd57335437042a3674dc2b Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:43:38 +0200 Subject: [PATCH 11/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py.WithdrawRoutes --- .../withdraw_routes/withdraw_routes.py | 8 +++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py index 1c32e489c4..d5810bb7df 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py +++ b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py @@ -112,7 +112,13 @@ class WithdrawRoutesTable(CliveCheckerboardTable): class WithdrawRoutes(TabPane, OperationActionBindings): - """TabPane with all content about setting withdraw routes.""" + """ + TabPane with all content about setting withdraw routes. + + Attributes: + DEFAULT_CSS: Default CSS for the withdraw routes screen. + DEFAULT_AUTO_VEST: Default value for the auto vest checkbox. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) DEFAULT_AUTO_VEST: Final[bool] = False diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index b035a16468..9704405414 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -415,10 +415,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow DOC103: Method `WithdrawRoutesDisplay._update_withdraw_routes`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: HivePowerData | NotUpdatedYet]. DOC201: Method `PowerDown._calculate_one_withdrawal` does not have a return section in docstring -------------------- -clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py - DOC601: Class `WithdrawRoutes`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `WithdrawRoutes`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_AUTO_VEST: Final[bool], DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -- GitLab From 97a82fdb47050cceced86d28af45c12938224fba Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:46:19 +0200 Subject: [PATCH 12/89] Fix pydoclint errors in ui/screens/settings/account_management/bad_accounts.py.BadAccountsTable --- .../settings/account_management/bad_accounts.py | 10 +++++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/screens/settings/account_management/bad_accounts.py b/clive/__private/ui/screens/settings/account_management/bad_accounts.py index 0c4f896b8b..94894f5c3d 100644 --- a/clive/__private/ui/screens/settings/account_management/bad_accounts.py +++ b/clive/__private/ui/screens/settings/account_management/bad_accounts.py @@ -27,7 +27,15 @@ if TYPE_CHECKING: class BadAccountsTable(CliveCheckerboardTable): - """Table for a bad accounts.""" + """ + Table for a bad accounts. + + Attributes: + DEFAULT_CSS: Default CSS for the bad accounts table. + BINDINGS: Key bindings for navigating through pages. + MAX_ACCOUNTS_ON_PAGE: Maximum number of accounts displayed on one page. + FIRST_PAGE_INDEX: Index of the first page. + """ DEFAULT_CSS = """ BadAccountsTable { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 9704405414..a57af63f55 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -419,8 +419,6 @@ clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- clive/__private/ui/screens/settings/account_management/bad_accounts.py - DOC601: Class `BadAccountsTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `BadAccountsTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [BINDINGS: , DEFAULT_CSS: , FIRST_PAGE_INDEX: Final[int], MAX_ACCOUNTS_ON_PAGE: Final[int]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `BadAccounts`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `BadAccounts`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , TITLE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -------------------- -- GitLab From 200b67a4a3f55a367136e094314be0503a7dc43d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:47:04 +0200 Subject: [PATCH 13/89] Fix pydoclint errors in ui/screens/settings/account_management/bad_accounts.py.BadAccounts --- .../screens/settings/account_management/bad_accounts.py | 8 +++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/settings/account_management/bad_accounts.py b/clive/__private/ui/screens/settings/account_management/bad_accounts.py index 94894f5c3d..35c5e87bf9 100644 --- a/clive/__private/ui/screens/settings/account_management/bad_accounts.py +++ b/clive/__private/ui/screens/settings/account_management/bad_accounts.py @@ -152,7 +152,13 @@ class BadAccountsTable(CliveCheckerboardTable): class BadAccounts(TabPane): - """Currently only used to display the list of bad accounts (cannot be modified).""" + """ + Currently only used to display the list of bad accounts (cannot be modified). + + Attributes: + DEFAULT_CSS: Default CSS for the BadAccounts screen. + TITLE: Title of the BadAccounts screen. + """ DEFAULT_CSS = """ BadAccounts { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index a57af63f55..4a3be6d12b 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,10 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/settings/account_management/bad_accounts.py - DOC601: Class `BadAccounts`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `BadAccounts`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , TITLE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/settings/account_management/common/manage_accounts_tab_pane.py DOC601: Class `ManageAccountsTabPane`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `ManageAccountsTabPane`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 3176968bf6b974331ac80c6e64bba2d8c018e98b Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:48:12 +0200 Subject: [PATCH 14/89] Fix pydoclint errors in ui/screens/settings/account_management/common/manage_accounts_tab_pane.py.ManageAccountsTabPane --- .../common/manage_accounts_tab_pane.py | 11 ++++++++++- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/screens/settings/account_management/common/manage_accounts_tab_pane.py b/clive/__private/ui/screens/settings/account_management/common/manage_accounts_tab_pane.py index 472a0cea41..60b85c6732 100644 --- a/clive/__private/ui/screens/settings/account_management/common/manage_accounts_tab_pane.py +++ b/clive/__private/ui/screens/settings/account_management/common/manage_accounts_tab_pane.py @@ -23,7 +23,16 @@ if TYPE_CHECKING: class ManageAccountsTabPane(TabPane, CliveWidget): - """TabPane used to add and delete watched or known accounts.""" + """ + TabPane used to add and delete watched or known accounts. + + Attributes: + DEFAULT_CSS: Default CSS for the manage accounts tab pane. + + Args: + title: Title of the tab pane. + accounts_type: Type of accounts to manage. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 4a3be6d12b..067ab20e9e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,12 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/settings/account_management/common/manage_accounts_tab_pane.py - DOC601: Class `ManageAccountsTabPane`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `ManageAccountsTabPane`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `ManageAccountsTabPane.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `ManageAccountsTabPane.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [accounts_type: AccountsType, title: str]. --------------------- clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py DOC601: Class `ManageAccountsTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `ManageAccountsTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , DEFAULT_CSS: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From ea74c1ad84f56290e1ae05d05dab7b8eb06fec61 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:49:14 +0200 Subject: [PATCH 15/89] Fix pydoclint errors in ui/screens/settings/account_management/common/manage_accounts_table.py.ManageAccountsTable --- .../common/manage_accounts_table.py | 12 +++++++++++- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py b/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py index 9c8d4afa51..a378d8baa8 100644 --- a/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py +++ b/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py @@ -62,7 +62,17 @@ class AccountRow(CliveCheckerboardTableRow): class ManageAccountsTable(CliveCheckerboardTable): - """Common table for a known and watched accounts.""" + """ + Common table for a known and watched accounts. + + Attributes: + DEFAULT_CSS: Default CSS for the manage accounts table. + ATTRIBUTE_TO_WATCH: Attribute of the Profile to watch for updates. + NO_CONTENT_TEXT: Text to display when there are no accounts. + + Args: + accounts_type: Type of accounts to manage (known or tracked). + """ DEFAULT_CSS = """ ManageAccountsTable { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 067ab20e9e..ce0ab8a77e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,12 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py - DOC601: Class `ManageAccountsTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `ManageAccountsTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , DEFAULT_CSS: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `ManageAccountsTable.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `ManageAccountsTable.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [accounts_type: AccountsType]. --------------------- clive/__private/ui/screens/settings/account_management/known_accounts.py DOC601: Class `KnownAccounts`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `KnownAccounts`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [TITLE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 5c95e2f1210f80eb32bbe4b479c724ffdc461d27 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:50:06 +0200 Subject: [PATCH 16/89] Fix pydoclint errors in ui/screens/settings/account_management/known_accounts.py.KnownAccounts --- .../screens/settings/account_management/known_accounts.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/settings/account_management/known_accounts.py b/clive/__private/ui/screens/settings/account_management/known_accounts.py index 390a44b7a4..85bd9c96fc 100644 --- a/clive/__private/ui/screens/settings/account_management/known_accounts.py +++ b/clive/__private/ui/screens/settings/account_management/known_accounts.py @@ -6,7 +6,12 @@ from clive.__private.ui.screens.settings.account_management.common.manage_accoun class KnownAccounts(ManageAccountsTabPane): - """TabPane used to add and delete known accounts.""" + """ + TabPane used to add and delete known accounts. + + Attributes: + TITLE: Title of the tab pane. + """ TITLE: Final[str] = "Known accounts" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index ce0ab8a77e..37c1f4f26e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,10 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/settings/account_management/known_accounts.py - DOC601: Class `KnownAccounts`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `KnownAccounts`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [TITLE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/settings/account_management/tracked_accounts.py DOC601: Class `TrackedAccounts`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `TrackedAccounts`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , TITLE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 3aeec0832bac28ce2d7d1305c94905840634e26b Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:51:25 +0200 Subject: [PATCH 17/89] Fix pydoclint errors in ui/screens/settings/account_management/tracked_accounts.py.TrackedAccounts --- .../settings/account_management/tracked_accounts.py | 8 +++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/settings/account_management/tracked_accounts.py b/clive/__private/ui/screens/settings/account_management/tracked_accounts.py index 415320272d..30af3112ba 100644 --- a/clive/__private/ui/screens/settings/account_management/tracked_accounts.py +++ b/clive/__private/ui/screens/settings/account_management/tracked_accounts.py @@ -6,7 +6,13 @@ from clive.__private.ui.screens.settings.account_management.common.manage_accoun class TrackedAccounts(ManageAccountsTabPane): - """TabPane used to add and delete tracked accounts.""" + """ + TabPane used to add and delete tracked accounts. + + Attributes: + DEFAULT_CSS: Default CSS for the tracked accounts tab pane. + TITLE: Title of the tab pane. + """ DEFAULT_CSS = """ TrackedAccounts { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 37c1f4f26e..4dda3602bd 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,10 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/settings/account_management/tracked_accounts.py - DOC601: Class `TrackedAccounts`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `TrackedAccounts`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , TITLE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py DOC601: Class `ManageKeyAliasesTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `ManageKeyAliasesTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 09741c58452c3c093b7509c4700e1ad3dcb52ef7 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:53:15 +0200 Subject: [PATCH 18/89] Fix pydoclint errors in ui/screens/settings/manage_key_aliases/manage_key_aliases.py.ManageKeyAliasesTable --- .../settings/manage_key_aliases/manage_key_aliases.py | 8 +++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py b/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py index 33be3d1d8c..51ae6dc5bc 100644 --- a/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py +++ b/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py @@ -130,7 +130,13 @@ class KeyAliasesHeader(Horizontal): class ManageKeyAliasesTable(CliveCheckerboardTable): - """Table with KeyAliases.""" + """ + Table with KeyAliases. + + Attributes: + ATTRIBUTE_TO_WATCH: Attribute of the Profile to watch for updates. + NO_CONTENT_TEXT: Text to display when there are no key aliases. + """ ATTRIBUTE_TO_WATCH = "profile_reactive" NO_CONTENT_TEXT = "You have no key aliases" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 4dda3602bd..352f010bc0 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,10 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py - DOC601: Class `ManageKeyAliasesTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `ManageKeyAliasesTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [ATTRIBUTE_TO_WATCH: , NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/transaction_summary/cart_table.py DOC101: Method `MoveUpButton.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `MoveUpButton.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [disabled: bool]. -- GitLab From 4169c65a37cb96445c0b372e05ab1f418913c44e Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:55:05 +0200 Subject: [PATCH 19/89] Fix pydoclint errors in ui/screens/transaction_summary/cart_table.py.MoveDownButton --- .../ui/screens/transaction_summary/cart_table.py | 14 ++++++++++++-- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/clive/__private/ui/screens/transaction_summary/cart_table.py b/clive/__private/ui/screens/transaction_summary/cart_table.py index cdd335ea6f..c818963de9 100644 --- a/clive/__private/ui/screens/transaction_summary/cart_table.py +++ b/clive/__private/ui/screens/transaction_summary/cart_table.py @@ -35,14 +35,24 @@ if TYPE_CHECKING: class MoveUpButton(CliveButton): - """Button used for moving the operation up in the cart.""" + """ + Button used for moving the operation up in the cart. + + Args: + disabled: Whether the button should be disabled initially. + """ def __init__(self, *, disabled: bool = False) -> None: super().__init__("↑", id_="move-up-button", disabled=disabled) class MoveDownButton(CliveButton): - """Button used for moving the operation down in the cart.""" + """ + Button used for moving the operation down in the cart. + + Args: + disabled: Whether the button should be disabled initially. + """ def __init__(self, *, disabled: bool = False) -> None: super().__init__("↓", id_="move-down-button", disabled=disabled) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 352f010bc0..965b466235 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -419,10 +419,6 @@ clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- clive/__private/ui/screens/transaction_summary/cart_table.py - DOC101: Method `MoveUpButton.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `MoveUpButton.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [disabled: bool]. - DOC101: Method `MoveDownButton.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `MoveDownButton.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [disabled: bool]. DOC601: Class `CartTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `CartTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `Modified`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 84018d1441a4e5439576e4e72917c7c2ea5fabc0 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:57:48 +0200 Subject: [PATCH 20/89] Fix pydoclint errors in ui/screens/transaction_summary/cart_table.py.CartTable --- .../__private/ui/screens/transaction_summary/cart_table.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/screens/transaction_summary/cart_table.py b/clive/__private/ui/screens/transaction_summary/cart_table.py index c818963de9..9efb387a47 100644 --- a/clive/__private/ui/screens/transaction_summary/cart_table.py +++ b/clive/__private/ui/screens/transaction_summary/cart_table.py @@ -267,7 +267,12 @@ class CartHeader(Horizontal): class CartTable(CliveCheckerboardTable): - """Table with CartItems.""" + """ + Table with CartItems. + + Attributes: + NO_CONTENT_TEXT: Text displayed when there are no items in the cart. + """ NO_CONTENT_TEXT = "Cart is empty" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 965b466235..02cfd1f8c2 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -419,8 +419,6 @@ clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- clive/__private/ui/screens/transaction_summary/cart_table.py - DOC601: Class `CartTable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `CartTable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [NO_CONTENT_TEXT: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `Modified`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `Modified`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [transaction: Transaction]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -------------------- -- GitLab From 9df568cb99d9c68f71db0808f14b852384b4aa0b Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:58:25 +0200 Subject: [PATCH 21/89] Fix pydoclint errors in ui/screens/transaction_summary/cart_table.py.Modified --- .../__private/ui/screens/transaction_summary/cart_table.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/transaction_summary/cart_table.py b/clive/__private/ui/screens/transaction_summary/cart_table.py index 9efb387a47..ddc1abb677 100644 --- a/clive/__private/ui/screens/transaction_summary/cart_table.py +++ b/clive/__private/ui/screens/transaction_summary/cart_table.py @@ -278,7 +278,12 @@ class CartTable(CliveCheckerboardTable): @dataclass class Modified(Message): - """Message sent when operations in CartTable were reordered or removed.""" + """ + Message sent when operations in cart table were reordered or removed. + + Attributes: + transaction: The modified transaction after the operations were reordered or removed. + """ transaction: Transaction diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 02cfd1f8c2..8ff13b160e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,10 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/transaction_summary/cart_table.py - DOC601: Class `Modified`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `Modified`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [transaction: Transaction]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py DOC601: Class `TaposHolder`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `TaposHolder`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [transaction: Transaction]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 5ecfe4dbd2c418fd1cc1704d2b3f0eaccd202cae Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:43:13 +0200 Subject: [PATCH 22/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py.WithdrawRoutesTable --- .../hive_power_management/withdraw_routes/withdraw_routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py index d5810bb7df..dd12969c2e 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py +++ b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py @@ -75,7 +75,7 @@ class WithdrawRoutesTable(CliveCheckerboardTable): Table with WithdrawRoutes. Attributes: - ATTRIBUTE_TO_WATCH: Attribute of the HivePowerDataProvider to watch for updates. + ATTRIBUTE_TO_WATCH: Attribute to watch for updates. NO_CONTENT_TEXT: Text to display when there are no withdraw routes. """ -- GitLab From b373eb41c010606eed1fe4268f693da381eaba0e Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:43:38 +0200 Subject: [PATCH 23/89] Fix pydoclint errors in ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py.WithdrawRoutes --- .../hive_power_management/withdraw_routes/withdraw_routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py index dd12969c2e..9e8ba97b3c 100644 --- a/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py +++ b/clive/__private/ui/screens/operations/hive_power_management/withdraw_routes/withdraw_routes.py @@ -116,7 +116,7 @@ class WithdrawRoutes(TabPane, OperationActionBindings): TabPane with all content about setting withdraw routes. Attributes: - DEFAULT_CSS: Default CSS for the withdraw routes screen. + DEFAULT_CSS: Default CSS for the withdraw routes tab pane. DEFAULT_AUTO_VEST: Default value for the auto vest checkbox. """ -- GitLab From c703db1d7203e974e193534aec9dbfbba101497f Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:47:04 +0200 Subject: [PATCH 24/89] Fix pydoclint errors in ui/screens/settings/account_management/bad_accounts.py.BadAccounts --- .../ui/screens/settings/account_management/bad_accounts.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/clive/__private/ui/screens/settings/account_management/bad_accounts.py b/clive/__private/ui/screens/settings/account_management/bad_accounts.py index 35c5e87bf9..df7cb57353 100644 --- a/clive/__private/ui/screens/settings/account_management/bad_accounts.py +++ b/clive/__private/ui/screens/settings/account_management/bad_accounts.py @@ -156,8 +156,8 @@ class BadAccounts(TabPane): Currently only used to display the list of bad accounts (cannot be modified). Attributes: - DEFAULT_CSS: Default CSS for the BadAccounts screen. - TITLE: Title of the BadAccounts screen. + DEFAULT_CSS: Default CSS for the BadAccounts tab pane. + TITLE: Title of the BadAccounts tab pane. """ DEFAULT_CSS = """ -- GitLab From 395c323f2d816bf04a470acbcf84ac60dc2f260c Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:49:14 +0200 Subject: [PATCH 25/89] Fix pydoclint errors in ui/screens/settings/account_management/common/manage_accounts_table.py.ManageAccountsTable --- .../settings/account_management/common/manage_accounts_table.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py b/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py index a378d8baa8..81379fc15c 100644 --- a/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py +++ b/clive/__private/ui/screens/settings/account_management/common/manage_accounts_table.py @@ -67,7 +67,7 @@ class ManageAccountsTable(CliveCheckerboardTable): Attributes: DEFAULT_CSS: Default CSS for the manage accounts table. - ATTRIBUTE_TO_WATCH: Attribute of the Profile to watch for updates. + ATTRIBUTE_TO_WATCH: Attribute to watch for updates. NO_CONTENT_TEXT: Text to display when there are no accounts. Args: -- GitLab From 251701d5e356a6939039aab846ede89a67ce357e Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 16:53:15 +0200 Subject: [PATCH 26/89] Fix pydoclint errors in ui/screens/settings/manage_key_aliases/manage_key_aliases.py.ManageKeyAliasesTable --- .../screens/settings/manage_key_aliases/manage_key_aliases.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py b/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py index 51ae6dc5bc..85424f7a2f 100644 --- a/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py +++ b/clive/__private/ui/screens/settings/manage_key_aliases/manage_key_aliases.py @@ -134,7 +134,7 @@ class ManageKeyAliasesTable(CliveCheckerboardTable): Table with KeyAliases. Attributes: - ATTRIBUTE_TO_WATCH: Attribute of the Profile to watch for updates. + ATTRIBUTE_TO_WATCH: Attribute to watch for updates. NO_CONTENT_TEXT: Text to display when there are no key aliases. """ -- GitLab From a3d3b67585e430c2cfbc18220c732d636b2e37e7 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:21:57 +0200 Subject: [PATCH 27/89] Fix pydoclint errors in ui/screens/transaction_summary/transaction_metadata_container.py.TaposHolder --- .../transaction_metadata_container.py | 31 +++++++++++++++++-- pydoclint-errors-baseline.txt | 4 --- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py b/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py index d4e4aac875..9f33e86d79 100644 --- a/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py +++ b/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py @@ -20,7 +20,15 @@ if TYPE_CHECKING: class TaposHolder(Vertical): - """Container for the TaPoS metadata.""" + """Container for the TaPoS metadata. + + Attributes: + transaction: The transaction object containing TaPoS metadata to display. If changed - widget will automatically + refresh content of mounted labels. + + Args: + transaction: The transaction object to display tapos metadata for. + """ transaction: Transaction = var(None, init=False) # type: ignore[assignment] @@ -48,7 +56,15 @@ class TaposHolder(Vertical): class TransactionExpirationLabel(Label): - """Label for displaying transaction expiration.""" + """ + Label for displaying transaction expiration. + + Attributes: + expiration: Time when the transaction expires. If changed - displayed text will automatically update. + + Args: + expiration: Time when the transaction expires. Used to initialize `expiration` attribute. + """ expiration: datetime = reactive(None, init=False) # type: ignore[assignment] @@ -62,7 +78,16 @@ class TransactionExpirationLabel(Label): class TransactionIdLabel(Label): - """Label for displaying transaction id.""" + """ + Label for displaying transaction id. + + Attributes: + transaction_id: The unique identifier for the transaction. If changed displayed text of this label will + be automatically updated. + + Args: + transaction_id: The unique identifier of transaction. Used to initialize `transaction_id` attribute. + """ transaction_id: str = reactive(None, init=False) # type: ignore[assignment] diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 8ff13b160e..a1d286ad23 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -419,10 +419,6 @@ clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py - DOC601: Class `TaposHolder`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `TaposHolder`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [transaction: Transaction]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `TaposHolder.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `TaposHolder.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [transaction: Transaction]. DOC601: Class `TransactionExpirationLabel`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `TransactionExpirationLabel`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [expiration: datetime]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `TransactionExpirationLabel.__init__`: Docstring contains fewer arguments than in function signature. -- GitLab From f025c2d08f6f706451d45eea679b438ec475df16 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:23:42 +0200 Subject: [PATCH 28/89] Fix pydoclint errors in ui/screens/transaction_summary/transaction_metadata_container.py.TransactionExpirationLabel --- .../transaction_summary/transaction_metadata_container.py | 2 +- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py b/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py index 9f33e86d79..9ab1151228 100644 --- a/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py +++ b/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py @@ -63,7 +63,7 @@ class TransactionExpirationLabel(Label): expiration: Time when the transaction expires. If changed - displayed text will automatically update. Args: - expiration: Time when the transaction expires. Used to initialize `expiration` attribute. + expiration: Time when the transaction expires. """ expiration: datetime = reactive(None, init=False) # type: ignore[assignment] diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index a1d286ad23..b033abefec 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -419,10 +419,6 @@ clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py - DOC601: Class `TransactionExpirationLabel`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `TransactionExpirationLabel`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [expiration: datetime]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `TransactionExpirationLabel.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `TransactionExpirationLabel.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [expiration: datetime]. DOC601: Class `TransactionIdLabel`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `TransactionIdLabel`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [transaction_id: str]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `TransactionIdLabel.__init__`: Docstring contains fewer arguments than in function signature. -- GitLab From 5f81e0203b094a76e7eaba0578aa1b2a2b29293c Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:25:15 +0200 Subject: [PATCH 29/89] Fix pydoclint errors in ui/screens/transaction_summary/transaction_metadata_container.py.TransactionIdLabel --- .../transaction_summary/transaction_metadata_container.py | 4 ++-- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py b/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py index 9ab1151228..d8dc515d9f 100644 --- a/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py +++ b/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py @@ -83,10 +83,10 @@ class TransactionIdLabel(Label): Attributes: transaction_id: The unique identifier for the transaction. If changed displayed text of this label will - be automatically updated. + be automatically updated. Args: - transaction_id: The unique identifier of transaction. Used to initialize `transaction_id` attribute. + transaction_id: The unique identifier of transaction. """ transaction_id: str = reactive(None, init=False) # type: ignore[assignment] diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index b033abefec..ae71513c94 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,12 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py - DOC601: Class `TransactionIdLabel`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `TransactionIdLabel`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [transaction_id: str]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `TransactionIdLabel.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `TransactionIdLabel.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [transaction_id: str]. --------------------- clive/__private/ui/screens/transaction_summary/transaction_summary.py DOC601: Class `AlreadySignedHint`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `AlreadySignedHint`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From f626120fd4824bced8d2935ee233868a5668c160 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:26:21 +0200 Subject: [PATCH 30/89] Fix pydoclint errors in ui/screens/transaction_summary/transaction_summary.py.AlreadySignedHint --- .../ui/screens/transaction_summary/transaction_summary.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/screens/transaction_summary/transaction_summary.py b/clive/__private/ui/screens/transaction_summary/transaction_summary.py index 78c51ba347..c7bba86284 100644 --- a/clive/__private/ui/screens/transaction_summary/transaction_summary.py +++ b/clive/__private/ui/screens/transaction_summary/transaction_summary.py @@ -41,7 +41,12 @@ if TYPE_CHECKING: class AlreadySignedHint(Label): - """Hint about the already signed transaction.""" + """ + Hint about the already signed transaction. + + Attributes: + DEFAULT_CSS: Default CSS for styling the hint. + """ DEFAULT_CSS = """ AlreadySignedHint { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index ae71513c94..dbba2a21d8 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -418,10 +418,6 @@ clive/__private/ui/screens/operations/hive_power_management/power_down/power_dow clive/__private/ui/screens/operations/transfer_to_account/transfer_to_account.py DOC201: Method `TransferToAccount._check_is_known_exchange_in_input` does not have a return section in docstring -------------------- -clive/__private/ui/screens/transaction_summary/transaction_summary.py - DOC601: Class `AlreadySignedHint`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `AlreadySignedHint`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/widgets/apr.py DOC101: Method `APR._get_apr`: Docstring contains fewer arguments than in function signature. DOC103: Method `APR._get_apr`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. -- GitLab From a3ef56a8d214d57d85ddd9abd5b61224a98e0abd Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:30:43 +0200 Subject: [PATCH 31/89] Fix pydoclint errors in ui/widgets/buttons/clive_button.py.CliveButton --- .../ui/widgets/buttons/clive_button.py | 18 +++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/buttons/clive_button.py b/clive/__private/ui/widgets/buttons/clive_button.py index 0f659e144e..db2dd60502 100644 --- a/clive/__private/ui/widgets/buttons/clive_button.py +++ b/clive/__private/ui/widgets/buttons/clive_button.py @@ -29,7 +29,23 @@ CliveButtonVariant = Literal[ class CliveButton(Button, CliveWidget): - """A regular Textual button which also displays "enter" action binding.""" + """ + A regular Textual button which also displays "enter" action binding. + + Attributes: + DEFAULT_CSS: Default CSS styles for the button. + variant: The variant of the button. + + Args: + label: The label of the button. + variant: The variant of the button. + binding: Optional binding to display next to the label. + id_: Optional ID for the button. + classes: Optional CSS classes for the button. + disabled: Whether the button is disabled. + ellipsis_: Whether to apply ellipsis to the label text. + + """ class Pressed(Button.Pressed): """Event sent when a `CliveButton` is pressed.""" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index dbba2a21d8..cc2e762ce6 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,10 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/buttons/clive_button.py - DOC601: Class `CliveButton`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `CliveButton`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , variant: reactive[CliveButtonVariant]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `CliveButton.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveButton.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [binding: CliveBinding | None, classes: str | None, disabled: bool, ellipsis_: bool, id_: str | None, label: TextType | None, variant: CliveButtonVariant]. DOC101: Method `CliveButton.fix_for_textual_button_pressed_namespace`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveButton.fix_for_textual_button_pressed_namespace`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [event: Button.Pressed]. DOC101: Method `CliveButton.validate_variant`: Docstring contains fewer arguments than in function signature. -- GitLab From 20bba0fcf010a7b00b9298a328184c83028e3b22 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:37:28 +0200 Subject: [PATCH 32/89] Fix pydoclint errors in ui/widgets/buttons/clive_button.py.CliveButton.fix_for_textual_button_pressed_namespace --- clive/__private/ui/widgets/buttons/clive_button.py | 7 +++++-- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/clive/__private/ui/widgets/buttons/clive_button.py b/clive/__private/ui/widgets/buttons/clive_button.py index db2dd60502..ac80385426 100644 --- a/clive/__private/ui/widgets/buttons/clive_button.py +++ b/clive/__private/ui/widgets/buttons/clive_button.py @@ -152,8 +152,11 @@ class CliveButton(Button, CliveWidget): Change Button.Pressed namespace to self.Pressed to allow for correct namespace handling. Related issues: - - https://github.com/Textualize/textual/issues/4967 - - https://github.com/Textualize/textual/issues/1814 + - https://github.com/Textualize/textual/issues/4967 + - https://github.com/Textualize/textual/issues/1814 + + Args: + event: The Button.Pressed event that was triggered. """ if type(event) is Button.Pressed: event.stop() diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index cc2e762ce6..40626db528 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,8 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/buttons/clive_button.py - DOC101: Method `CliveButton.fix_for_textual_button_pressed_namespace`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveButton.fix_for_textual_button_pressed_namespace`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [event: Button.Pressed]. DOC101: Method `CliveButton.validate_variant`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveButton.validate_variant`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [variant: str]. DOC201: Method `CliveButton.validate_variant` does not have a return section in docstring -- GitLab From e16a306af239754484bb8a07d7d34324ff858699 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:38:23 +0200 Subject: [PATCH 33/89] Fix pydoclint errors in ui/widgets/buttons/clive_button.py.CliveButton.validate_variant --- clive/__private/ui/widgets/buttons/clive_button.py | 10 +++++++++- pydoclint-errors-baseline.txt | 5 ----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/clive/__private/ui/widgets/buttons/clive_button.py b/clive/__private/ui/widgets/buttons/clive_button.py index ac80385426..fd361d0b1d 100644 --- a/clive/__private/ui/widgets/buttons/clive_button.py +++ b/clive/__private/ui/widgets/buttons/clive_button.py @@ -163,7 +163,15 @@ class CliveButton(Button, CliveWidget): self.post_message(self.Pressed(self)) def validate_variant(self, variant: str) -> str: - """No need for runtime validation, as invalid variant will be detected by mypy.""" + """ + No need for runtime validation, as invalid variant will be detected by mypy. + + Args: + variant: The variant to validate. + + Returns: + The validated variant. + """ return variant def _create_label(self, label: TextType, binding: CliveBinding | None = None) -> TextType: diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 40626db528..607c24b65c 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -423,11 +423,6 @@ clive/__private/ui/widgets/apr.py DOC103: Method `APR._get_apr`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- -clive/__private/ui/widgets/buttons/clive_button.py - DOC101: Method `CliveButton.validate_variant`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveButton.validate_variant`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [variant: str]. - DOC201: Method `CliveButton.validate_variant` does not have a return section in docstring --------------------- clive/__private/ui/widgets/buttons/generous_button.py DOC601: Class `GenerousButton`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `GenerousButton`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 59342e17c804a1f3dc25b485d01b2d9d5829567d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:39:29 +0200 Subject: [PATCH 34/89] Fix pydoclint errors in ui/widgets/buttons/generous_button.py.GenerousButton --- .../__private/ui/widgets/buttons/generous_button.py | 13 ++++++++++++- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/widgets/buttons/generous_button.py b/clive/__private/ui/widgets/buttons/generous_button.py index b02f7ce2c1..c289f8d1b3 100644 --- a/clive/__private/ui/widgets/buttons/generous_button.py +++ b/clive/__private/ui/widgets/buttons/generous_button.py @@ -14,7 +14,18 @@ if TYPE_CHECKING: class GenerousButton(CliveButton): - """Button that fill the related input with the entire selected asset balance.""" + """ + Button that fill the related input with the entire selected asset balance. + + Attributes: + DEFAULT_CSS: Default CSS styles for the GenerousButton. + + Args: + related_input: The input field that will be filled with the asset balance. + amount_callback: A callable that returns the current asset balance. + id_: Optional ID for the button. + classes: Optional CSS classes for the button. + """ class Pressed(CliveButton.Pressed): """Used to identify exactly that GenerousButton was pressed.""" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 607c24b65c..be133ee8af 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -423,12 +423,6 @@ clive/__private/ui/widgets/apr.py DOC103: Method `APR._get_apr`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- -clive/__private/ui/widgets/buttons/generous_button.py - DOC601: Class `GenerousButton`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `GenerousButton`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `GenerousButton.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `GenerousButton.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [amount_callback: Callable[[], Asset.AnyT], classes: str | None, id_: str | None, related_input: CliveValidatedInput[Asset.AnyT]]. --------------------- clive/__private/ui/widgets/buttons/one_line_button.py DOC601: Class `OneLineButton`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `OneLineButton`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From ddab4e92e97bea74f112c2c09f8a543ca568daab Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:41:15 +0200 Subject: [PATCH 35/89] Fix pydoclint errors in ui/widgets/buttons/one_line_button.py.OneLineButton --- clive/__private/ui/widgets/buttons/one_line_button.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/buttons/one_line_button.py b/clive/__private/ui/widgets/buttons/one_line_button.py index 566fd4a1f4..a19fe59e8e 100644 --- a/clive/__private/ui/widgets/buttons/one_line_button.py +++ b/clive/__private/ui/widgets/buttons/one_line_button.py @@ -4,7 +4,12 @@ from clive.__private.ui.widgets.buttons.clive_button import CliveButton class OneLineButton(CliveButton): - """Button that is without border around it, so it can be used in one line.""" + """ + Button that is without border around it, so it can be used in one line. + + Attributes: + DEFAULT_CSS: Default CSS styles for the OneLineButton. + """ class Pressed(CliveButton.Pressed): """Used to identify exactly that OneLineButton was pressed.""" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index be133ee8af..2b4953aa83 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -423,10 +423,6 @@ clive/__private/ui/widgets/apr.py DOC103: Method `APR._get_apr`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- -clive/__private/ui/widgets/buttons/one_line_button.py - DOC601: Class `OneLineButton`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `OneLineButton`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py DOC601: Class `CliveCheckerboardTableRow`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `CliveCheckerboardTableRow`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From cd092802d5a411ad2bedd50941549209d814c3ac Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:42:29 +0200 Subject: [PATCH 36/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTableRow --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 1 + pydoclint-errors-baseline.txt | 2 -- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index d245fa1828..6d166ad9f6 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -104,6 +104,7 @@ class CliveCheckerboardTableRow(CliveWidget): Row with checkerboard columns. Attributes: + DEFAULT_CSS: Default CSS for the row. BINDINGS: Key bindings for row. Args: diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 2b4953aa83..047428e6ab 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,8 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py - DOC601: Class `CliveCheckerboardTableRow`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `CliveCheckerboardTableRow`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `CliveCheckerboardTable.rebuild`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveCheckerboardTable.rebuild`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT | NotUpdatedYet | None]. DOC101: Method `CliveCheckerboardTable.rebuild_rows`: Docstring contains fewer arguments than in function signature. -- GitLab From d3ca7331e71dede132cbb443dc6d12665643b21c Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:45:25 +0200 Subject: [PATCH 37/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.rebuild --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index 6d166ad9f6..2bcef289bb 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -344,7 +344,12 @@ class CliveCheckerboardTable(CliveWidget): await self.rebuild(content) async def rebuild(self, content: ContentT | NotUpdatedYet | None = None) -> None: - """Rebuilds whole table - explicit use available for static and dynamic version.""" + """ + Rebuilds whole table - explicit use available for static and dynamic version. + + Args: + content: Content to be used for rebuilding the table. If None, it will use the current content. + """ with self.app.batch_update(): await self.query("*").remove() await self.mount_all(self._create_table_content(content)) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 047428e6ab..7c885d2e8d 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,8 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py - DOC101: Method `CliveCheckerboardTable.rebuild`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveCheckerboardTable.rebuild`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT | NotUpdatedYet | None]. DOC101: Method `CliveCheckerboardTable.rebuild_rows`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveCheckerboardTable.rebuild_rows`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT | NotUpdatedYet | None]. DOC101: Method `CliveCheckerboardTable.create_dynamic_rows`: Docstring contains fewer arguments than in function signature. -- GitLab From 04d30b65906d8930a2177d8d12f219943946c345 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:45:50 +0200 Subject: [PATCH 38/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.rebuild_rows --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index 2bcef289bb..a610a5ed49 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -355,7 +355,12 @@ class CliveCheckerboardTable(CliveWidget): await self.mount_all(self._create_table_content(content)) async def rebuild_rows(self, content: ContentT | NotUpdatedYet | None = None) -> None: - """Rebuilds table rows - explicit use available for static and dynamic version.""" + """ + Rebuilds table rows - explicit use available for static and dynamic version. + + Args: + content: Content to be used for rebuilding the rows. If None, it will use the current content. + """ with self.app.batch_update(): await self.query(CliveCheckerboardTableRow).remove() diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 7c885d2e8d..3242a1cca1 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,8 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py - DOC101: Method `CliveCheckerboardTable.rebuild_rows`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveCheckerboardTable.rebuild_rows`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT | NotUpdatedYet | None]. DOC101: Method `CliveCheckerboardTable.create_dynamic_rows`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveCheckerboardTable.create_dynamic_rows`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT]. DOC201: Method `CliveCheckerboardTable.create_dynamic_rows` does not have a return section in docstring -- GitLab From 50d8c05cfce7f3aba2d5bfd2a5b6903a7380a617 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:47:40 +0200 Subject: [PATCH 39/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.create_dynamic_rows --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 6 ++++++ pydoclint-errors-baseline.txt | 3 --- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index a610a5ed49..d8b24d0864 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -415,8 +415,14 @@ class CliveCheckerboardTable(CliveWidget): """ Override this method when using dynamic table (ATTRIBUTE_TO_WATCH is set). + Args: + content: The content to create rows from. + Raises: InvalidDynamicDefinedError: When ATTRIBUTE_TO_WATCH has been set without overriding the method. + + Returns: + A sequence of `CliveCheckerboardTableRow` instances to be displayed in the table. """ if self.should_be_dynamic: raise InvalidDynamicDefinedError diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 3242a1cca1..5e15874230 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,9 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py - DOC101: Method `CliveCheckerboardTable.create_dynamic_rows`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveCheckerboardTable.create_dynamic_rows`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT]. - DOC201: Method `CliveCheckerboardTable.create_dynamic_rows` does not have a return section in docstring DOC201: Method `CliveCheckerboardTable.create_static_rows` does not have a return section in docstring DOC101: Method `CliveCheckerboardTable.is_anything_to_display`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveCheckerboardTable.is_anything_to_display`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT]. -- GitLab From 57de0409a7d1bfa8066559474337c97dc1e3fe0f Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:48:16 +0200 Subject: [PATCH 40/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.create_static_rows --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 3 +++ pydoclint-errors-baseline.txt | 1 - 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index d8b24d0864..fa56aa7fc4 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -434,6 +434,9 @@ class CliveCheckerboardTable(CliveWidget): Raises: InvalidStaticDefinedError: When ATTRIBUTE_TO_WATCH has not been set without overriding the method. + + Returns: + A sequence of `CliveCheckerboardTableRow` instances to be displayed in the table. """ if not self.should_be_dynamic: raise InvalidStaticDefinedError diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 5e15874230..3ea6b81c7e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,7 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py - DOC201: Method `CliveCheckerboardTable.create_static_rows` does not have a return section in docstring DOC101: Method `CliveCheckerboardTable.is_anything_to_display`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveCheckerboardTable.is_anything_to_display`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT]. DOC201: Method `CliveCheckerboardTable.is_anything_to_display` does not have a return section in docstring -- GitLab From e58bc340193dde89311d43295ab8cc2c01ef95b0 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:47:40 +0200 Subject: [PATCH 41/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.create_dynamic_rows --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index fa56aa7fc4..003f34b950 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -422,7 +422,7 @@ class CliveCheckerboardTable(CliveWidget): InvalidDynamicDefinedError: When ATTRIBUTE_TO_WATCH has been set without overriding the method. Returns: - A sequence of `CliveCheckerboardTableRow` instances to be displayed in the table. + A sequence of row instances to be displayed in the table. """ if self.should_be_dynamic: raise InvalidDynamicDefinedError -- GitLab From a49f9309cc5dfdcce6119731d4b0fe239c14cc5d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:48:16 +0200 Subject: [PATCH 42/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.create_static_rows --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index 003f34b950..4d4bd9268c 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -436,7 +436,7 @@ class CliveCheckerboardTable(CliveWidget): InvalidStaticDefinedError: When ATTRIBUTE_TO_WATCH has not been set without overriding the method. Returns: - A sequence of `CliveCheckerboardTableRow` instances to be displayed in the table. + A sequence of row instances to be displayed in the table. """ if not self.should_be_dynamic: raise InvalidStaticDefinedError -- GitLab From 5d9ffdebfcdf1692a37b181c769e98cbe72768bc Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:49:41 +0200 Subject: [PATCH 43/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.is_anything_to_display --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 10 +++++++++- pydoclint-errors-baseline.txt | 3 --- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index 4d4bd9268c..921381dafd 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -489,7 +489,15 @@ class CliveCheckerboardTable(CliveWidget): cell.add_class(CLIVE_ODD_COLUMN_CLASS_NAME) def is_anything_to_display(self, content: ContentT) -> bool: # noqa: ARG002 - """Check whether there are elements to display. Should be overridden to create a custom condition.""" + """ + Check whether there are elements to display. Should be overridden to create a custom condition. + + Args: + content: The content to check if there is anything to display. + + Returns: + True if there is anything to display, False otherwise. + """ return True def update_previous_state(self, content: ContentT) -> None: # noqa: ARG002 diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 3ea6b81c7e..adb966b323 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,9 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py - DOC101: Method `CliveCheckerboardTable.is_anything_to_display`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveCheckerboardTable.is_anything_to_display`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT]. - DOC201: Method `CliveCheckerboardTable.is_anything_to_display` does not have a return section in docstring DOC101: Method `CliveCheckerboardTable.update_previous_state`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveCheckerboardTable.update_previous_state`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT]. DOC501: Method `CliveCheckerboardTable.update_previous_state` has raise statements, but the docstring does not have a "Raises" section -- GitLab From 8e15112572aebf5e88dda8612be385e57261759a Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:50:25 +0200 Subject: [PATCH 44/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_checkerboard_table.py.CliveCheckerboardTable.update_previous_state --- .../ui/widgets/clive_basic/clive_checkerboard_table.py | 6 ++++++ pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index 921381dafd..1c2b758a61 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py @@ -505,6 +505,12 @@ class CliveCheckerboardTable(CliveWidget): Must be overridden if the `ATTRIBUTE_TO_WATCH` class-var is set. Notice that you must also create your own previous state in the `__init__` method. + + Args: + content: The content to update the previous state with. + + Raises: + InvalidDynamicDefinedError: When ATTRIBUTE_TO_WATCH has been set without overriding the method. """ if self.should_be_dynamic: raise InvalidDynamicDefinedError diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index adb966b323..08649e3e7d 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -423,12 +423,6 @@ clive/__private/ui/widgets/apr.py DOC103: Method `APR._get_apr`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- -clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py - DOC101: Method `CliveCheckerboardTable.update_previous_state`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveCheckerboardTable.update_previous_state`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: ContentT]. - DOC501: Method `CliveCheckerboardTable.update_previous_state` has raise statements, but the docstring does not have a "Raises" section - DOC503: Method `CliveCheckerboardTable.update_previous_state` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: []. Raised exceptions in the body: ['InvalidDynamicDefinedError']. --------------------- clive/__private/ui/widgets/clive_basic/clive_data_table.py DOC101: Method `CliveDataTableRow.refresh_row`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveDataTableRow.refresh_row`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. -- GitLab From 563957e2206a0cac2f9b98f2c7900f0dc71e175c Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:53:39 +0200 Subject: [PATCH 45/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_data_table/CliveDataTableRow.py.refresh_row --- clive/__private/ui/widgets/clive_basic/clive_data_table.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_data_table.py b/clive/__private/ui/widgets/clive_basic/clive_data_table.py index 87078a60c0..13b72c38ee 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_data_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_data_table.py @@ -80,7 +80,12 @@ class CliveDataTableRow(Horizontal, CliveWidget): yield from self.cells def refresh_row(self, content: Any) -> None: # noqa: ANN401 - """Iterate through the cells and update each of them.""" + """ + Iterate through the cells and update each of them. + + Args: + content: The content to update the row with. Must be provided by the DataProvider. + """ for cell, value in zip(self.cells, self.get_new_values(content), strict=True): cell.update(value) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 08649e3e7d..51c958d552 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,8 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_data_table.py - DOC101: Method `CliveDataTableRow.refresh_row`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveDataTableRow.refresh_row`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. DOC101: Method `CliveDataTableRow.get_new_values`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveDataTableRow.get_new_values`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. DOC201: Method `CliveDataTableRow.get_new_values` does not have a return section in docstring -- GitLab From df3ead24657bebcbcf63c1e304bb81d3a45b87e2 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:54:29 +0200 Subject: [PATCH 46/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_data_table/CliveDataTableRow.py.get_new_values --- .../ui/widgets/clive_basic/clive_data_table.py | 13 ++++++++++++- pydoclint-errors-baseline.txt | 7 ------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_data_table.py b/clive/__private/ui/widgets/clive_basic/clive_data_table.py index 13b72c38ee..984365b695 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_data_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_data_table.py @@ -90,7 +90,18 @@ class CliveDataTableRow(Horizontal, CliveWidget): cell.update(value) def get_new_values(self, content: Any) -> tuple[str, ...]: # type: ignore[return] # noqa: ARG002, ANN401 - """Must be overridden if the `dynamic` parameter is set to True.""" + """ + Must be overridden if the `dynamic` parameter is set to True. + + Args: + content: The content to update the row with. Must be provided by the DataProvider. + + Raises: + CliveError: If this method is called on a static row. + + Returns: + A tuple of new values for the cells in the row. + """ if self._dynamic: raise CliveError("You must override this method if the row is dynamic.") diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 51c958d552..57f2831c3a 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -423,13 +423,6 @@ clive/__private/ui/widgets/apr.py DOC103: Method `APR._get_apr`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- -clive/__private/ui/widgets/clive_basic/clive_data_table.py - DOC101: Method `CliveDataTableRow.get_new_values`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveDataTableRow.get_new_values`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [content: Any]. - DOC201: Method `CliveDataTableRow.get_new_values` does not have a return section in docstring - DOC501: Method `CliveDataTableRow.get_new_values` has raise statements, but the docstring does not have a "Raises" section - DOC503: Method `CliveDataTableRow.get_new_values` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: []. Raised exceptions in the body: ['CliveError']. --------------------- clive/__private/ui/widgets/clive_basic/clive_header.py DOC101: Method `CliveRawHeader.prevent_header_expanding`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveRawHeader.prevent_header_expanding`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [event: events.Click]. -- GitLab From 4d1a2810acde1f2477a39a173af22e67684b8521 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:55:48 +0200 Subject: [PATCH 47/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_header.py.CliveRawHeader.prevent_header_expanding --- clive/__private/ui/widgets/clive_basic/clive_header.py | 3 +++ pydoclint-errors-baseline.txt | 2 -- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_header.py b/clive/__private/ui/widgets/clive_basic/clive_header.py index 42cdc9394b..fd824fea1c 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_header.py +++ b/clive/__private/ui/widgets/clive_basic/clive_header.py @@ -287,6 +287,9 @@ class CliveRawHeader(Header, CliveWidget): Default behavior of the textual header is to expand on click. We do not want behavior like that, so we had to override the `_on_click` method. We only allow for expanding the header by clicking on the HeaderIcon, not on the entire Header. + + Args: + event: The click event that triggered this method. """ event.prevent_default() diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 57f2831c3a..afee826e02 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -424,8 +424,6 @@ clive/__private/ui/widgets/apr.py DOC201: Method `APR._get_apr` does not have a return section in docstring -------------------- clive/__private/ui/widgets/clive_basic/clive_header.py - DOC101: Method `CliveRawHeader.prevent_header_expanding`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveRawHeader.prevent_header_expanding`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [event: events.Click]. DOC101: Method `CliveHeader._update_alarm_display_showing`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveHeader._update_alarm_display_showing`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [profile: Profile]. -------------------- -- GitLab From fd135b4e4f0ade56d2b5a6e3db2d26ea02e38f93 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:57:09 +0200 Subject: [PATCH 48/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_radio_button.py.CliveRadioButton --- .../__private/ui/widgets/clive_basic/clive_radio_button.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_radio_button.py b/clive/__private/ui/widgets/clive_basic/clive_radio_button.py index 16473bb0c2..7957d63fed 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_radio_button.py +++ b/clive/__private/ui/widgets/clive_basic/clive_radio_button.py @@ -4,6 +4,11 @@ from textual.widgets import RadioButton class CliveRadioButton(RadioButton): - """Due to bug in Ubuntu we have to replace icon of the RadioButton by simple 'O'.""" + """ + Due to bug in Ubuntu we have to replace icon of the RadioButton by simple 'O'. + + Attributes: + BUTTON_INNER: The inner content of the radio button, which is a simple 'O'. + """ BUTTON_INNER = "O" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index afee826e02..a58e8baa2e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -427,10 +427,6 @@ clive/__private/ui/widgets/clive_basic/clive_header.py DOC101: Method `CliveHeader._update_alarm_display_showing`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveHeader._update_alarm_display_showing`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [profile: Profile]. -------------------- -clive/__private/ui/widgets/clive_basic/clive_radio_button.py - DOC601: Class `CliveRadioButton`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `CliveRadioButton`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [BUTTON_INNER: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/widgets/currency_selector/currency_selector_base.py DOC201: Method `CurrencySelectorBase._create_selectable` does not have a return section in docstring DOC502: Method `CurrencySelectorBase.create_asset` has a "Raises" section in the docstring, but there are not "raise" statements in the body -- GitLab From d8aac03941801973926f0ab0cb38efcd2e8c2566 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:59:14 +0200 Subject: [PATCH 49/89] Fix pydoclint errors in ui/widgets/dialog_container.py.DialogContainer --- clive/__private/ui/widgets/dialog_container.py | 13 ++++++++++++- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/widgets/dialog_container.py b/clive/__private/ui/widgets/dialog_container.py index 8fdcd747a1..156c2837cf 100644 --- a/clive/__private/ui/widgets/dialog_container.py +++ b/clive/__private/ui/widgets/dialog_container.py @@ -19,7 +19,18 @@ class DialogBody(Container): class DialogContainer(Container, can_focus=False): - """A container for dialog-like looking widgets. Content stored inside this container will be centered.""" + """ + A container for dialog-like looking widgets. Content stored inside this container will be centered. + + Attributes: + DEFAULT_CSS: Default CSS styles for the dialog container. + + Args: + big_title: The big title of the dialog, displayed at the top. + section_title: The title of the section inside the dialog. + id_: Optional ID for the dialog container. + classes: Optional CSS classes for the dialog container. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index a58e8baa2e..c2169108f8 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -431,12 +431,6 @@ clive/__private/ui/widgets/currency_selector/currency_selector_base.py DOC201: Method `CurrencySelectorBase._create_selectable` does not have a return section in docstring DOC502: Method `CurrencySelectorBase.create_asset` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- -clive/__private/ui/widgets/dialog_container.py - DOC601: Class `DialogContainer`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `DialogContainer`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `DialogContainer.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `DialogContainer.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [big_title: str, classes: str | None, id_: str | None, section_title: str]. --------------------- clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py DOC601: Class `DynamicWidget`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `DynamicWidget`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From f30029caa6978c2cfd1792505e3da1a5639c8920 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:00:11 +0200 Subject: [PATCH 50/89] Fix pydoclint errors in ui/widgets/dynamic_widgets/dynamic_widget.py.DynamicWidget --- .../ui/widgets/dynamic_widgets/dynamic_widget.py | 16 +++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py b/clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py index e53428a45a..626af1af67 100644 --- a/clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py +++ b/clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py @@ -38,7 +38,21 @@ WidgetT = TypeVar("WidgetT", bound=Widget) class DynamicWidget(CliveWidget, AbstractClassMessagePump, Generic[WidgetT, CallbackReturnT]): # noqa: UP046 - """A widget that can be updated dynamically when a reactive variable changes.""" + """ + A widget that can be updated dynamically when a reactive variable changes. + + Attributes: + DEFAULT_CSS: Default CSS styles for the dynamic widget. + + Args: + obj_to_watch: The reactive object to watch for changes. + attribute_name: The name of the attribute to watch on the reactive object. + callback: A callback function that will be called when the attribute changes. + first_try_callback: A callback function that will be called before main callback to check if update is needed. + init: Whether to initialize the watcher immediately. + id_: Optional ID for the widget. + classes: Optional CSS classes for the widget. + """ DEFAULT_CSS = """ DynamicWidget { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index c2169108f8..a473734a14 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -432,10 +432,6 @@ clive/__private/ui/widgets/currency_selector/currency_selector_base.py DOC502: Method `CurrencySelectorBase.create_asset` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py - DOC601: Class `DynamicWidget`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `DynamicWidget`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `DynamicWidget.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `DynamicWidget.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [attribute_name: str, callback: DynamicWidgetCallbackType[CallbackReturnT], classes: str | None, first_try_callback: DynamicWidgetFirstTryCallbackType, id_: str | None, init: bool, obj_to_watch: Reactable]. DOC201: Method `DynamicWidget._create_widget` does not have a return section in docstring DOC101: Method `DynamicWidget._update_widget_state`: Docstring contains fewer arguments than in function signature. DOC103: Method `DynamicWidget._update_widget_state`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [result: CallbackReturnT]. -- GitLab From 687e0af7353052774f5ed7dec7a25aa9ef3434d5 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:00:59 +0200 Subject: [PATCH 51/89] Fix pydoclint errors in ui/widgets/ellipsed_static.py.EllipsedStatic --- clive/__private/ui/widgets/ellipsed_static.py | 9 ++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/ellipsed_static.py b/clive/__private/ui/widgets/ellipsed_static.py index c1f385cb62..0344adc66d 100644 --- a/clive/__private/ui/widgets/ellipsed_static.py +++ b/clive/__private/ui/widgets/ellipsed_static.py @@ -5,7 +5,14 @@ from textual.widgets import Static class EllipsedStatic(Static): - """A static widget that renders a string with ellipsis if it overflows.""" + """ + A static widget that renders a string with ellipsis if it overflows. + + Args: + renderable: The string to render in the widget. + id_: Optional ID for the widget. + classes: Optional CSS classes for the widget. + """ def __init__(self, renderable: str = "", *, id_: str | None = None, classes: str | None = None) -> None: super().__init__(id=id_, classes=classes) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index a473734a14..19f004be8d 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -436,10 +436,6 @@ clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py DOC101: Method `DynamicWidget._update_widget_state`: Docstring contains fewer arguments than in function signature. DOC103: Method `DynamicWidget._update_widget_state`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [result: CallbackReturnT]. -------------------- -clive/__private/ui/widgets/ellipsed_static.py - DOC101: Method `EllipsedStatic.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `EllipsedStatic.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [classes: str | None, id_: str | None, renderable: str]. --------------------- clive/__private/ui/widgets/inputs/account_name_pattern_input.py DOC101: Method `AccountNamePatternInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `AccountNamePatternInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: str | None]. -- GitLab From f9a4944e691b894e7403ad97466b1964cc022c0a Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:02:20 +0200 Subject: [PATCH 52/89] Fix pydoclint errors in ui/widgets/inputs/account_name_pattern_input.py.AccountNamePatternInput --- .../inputs/account_name_pattern_input.py | 19 ++++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/account_name_pattern_input.py b/clive/__private/ui/widgets/inputs/account_name_pattern_input.py index 2028b017b2..7a41fd1480 100644 --- a/clive/__private/ui/widgets/inputs/account_name_pattern_input.py +++ b/clive/__private/ui/widgets/inputs/account_name_pattern_input.py @@ -16,7 +16,24 @@ if TYPE_CHECKING: class AccountNamePatternInput(TextInput): - """An input for a Hive account name pattern.""" + """ + An input for a Hive account name pattern. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + suggester: An optional suggester for the input. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 19f004be8d..0393cbe708 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -436,10 +436,6 @@ clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py DOC101: Method `DynamicWidget._update_widget_state`: Docstring contains fewer arguments than in function signature. DOC103: Method `DynamicWidget._update_widget_state`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [result: CallbackReturnT]. -------------------- -clive/__private/ui/widgets/inputs/account_name_pattern_input.py - DOC101: Method `AccountNamePatternInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `AccountNamePatternInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: str | None]. --------------------- clive/__private/ui/widgets/inputs/asset_amount_base_input.py DOC502: Method `AssetAmountInput._value` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- -- GitLab From 7abf1e1f1e7523ab33358bea1e7ef6ede2184492 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:03:03 +0200 Subject: [PATCH 53/89] Fix pydoclint errors in ui/widgets/inputs/authority_filter_input.py.AuthorityFilterInput --- .../widgets/inputs/authority_filter_input.py | 20 ++++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/authority_filter_input.py b/clive/__private/ui/widgets/inputs/authority_filter_input.py index fd6973b379..3a5ec82895 100644 --- a/clive/__private/ui/widgets/inputs/authority_filter_input.py +++ b/clive/__private/ui/widgets/inputs/authority_filter_input.py @@ -18,7 +18,25 @@ if TYPE_CHECKING: class AuthorityFilterInput(TextInput): - """An input for authority entry - Hive account name, public / private key or alias.""" + """ + An input for authority entry - Hive account name, public / private key or alias. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + suggester: An optional suggester for the input. + validators: Validators to apply to the input value. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 0393cbe708..e6860c67b1 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -439,10 +439,6 @@ clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py clive/__private/ui/widgets/inputs/asset_amount_base_input.py DOC502: Method `AssetAmountInput._value` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- -clive/__private/ui/widgets/inputs/authority_filter_input.py - DOC101: Method `AuthorityFilterInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `AuthorityFilterInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. --------------------- clive/__private/ui/widgets/inputs/clive_input.py DOC101: Method `CliveInput.validate`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveInput.validate`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [treat_as_required: bool, value: str]. -- GitLab From f09f26feed7b9045a31fc49fea7a3c1ee73ad600 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:04:26 +0200 Subject: [PATCH 54/89] Fix pydoclint errors in ui/widgets/inputs/clive_input.py.CliveInput.validate --- clive/__private/ui/widgets/inputs/clive_input.py | 11 ++++++++++- pydoclint-errors-baseline.txt | 3 --- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_input.py b/clive/__private/ui/widgets/inputs/clive_input.py index 8482cd4504..4dcd267edc 100644 --- a/clive/__private/ui/widgets/inputs/clive_input.py +++ b/clive/__private/ui/widgets/inputs/clive_input.py @@ -202,7 +202,16 @@ class CliveInput(Input): self.remove_class(invalid_class if valid else valid_class) def validate(self, value: str, *, treat_as_required: bool = False) -> ValidationResult | None: - """Validate the value of the input.""" + """ + Validate the value of the input. + + Args: + value: The value to validate. + treat_as_required: If True, treat the input as required even if it is not. + + Returns: + The result of the validation. + """ if not self.required and not value and not treat_as_required: return ValidationResult.success() diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index e6860c67b1..2a8efb6b65 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -440,9 +440,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py DOC502: Method `AssetAmountInput._value` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- clive/__private/ui/widgets/inputs/clive_input.py - DOC101: Method `CliveInput.validate`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveInput.validate`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [treat_as_required: bool, value: str]. - DOC201: Method `CliveInput.validate` does not have a return section in docstring DOC101: Method `CliveInput.clear_validation`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveInput.clear_validation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [clear_value: bool]. -------------------- -- GitLab From 64f9662e5105dd68663c1f44f5f3cdf18cadf967 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:04:52 +0200 Subject: [PATCH 55/89] Fix pydoclint errors in ui/widgets/inputs/clive_input.py.CliveInput.clear_validation --- clive/__private/ui/widgets/inputs/clive_input.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_input.py b/clive/__private/ui/widgets/inputs/clive_input.py index 4dcd267edc..f1e50c4b3c 100644 --- a/clive/__private/ui/widgets/inputs/clive_input.py +++ b/clive/__private/ui/widgets/inputs/clive_input.py @@ -222,7 +222,12 @@ class CliveInput(Input): return result def clear_validation(self, *, clear_value: bool = True) -> None: - """Clear the validation of the input.""" + """ + Clear the validation of the input. + + Args: + clear_value: If True, also clear the value of the input. + """ if clear_value: self.clear() self._valid = True diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 2a8efb6b65..9bbeaf7aa3 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -439,10 +439,6 @@ clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py clive/__private/ui/widgets/inputs/asset_amount_base_input.py DOC502: Method `AssetAmountInput._value` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- -clive/__private/ui/widgets/inputs/clive_input.py - DOC101: Method `CliveInput.clear_validation`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveInput.clear_validation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [clear_value: bool]. --------------------- clive/__private/ui/widgets/inputs/clive_validated_input.py DOC101: Method `FailedValidationError.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `FailedValidationError.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [input_name: str | None, validation_result: ValidationResult]. -- GitLab From a6dc327fb7590309b37ed1a006d7451d66ab7dcd Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:07:30 +0200 Subject: [PATCH 56/89] Fix pydoclint errors in ui/widgets/inputs/clive_validated_input.py.FailedValidationError --- .../__private/ui/widgets/inputs/clive_validated_input.py | 8 +++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index be4304534c..127234ca15 100644 --- a/clive/__private/ui/widgets/inputs/clive_validated_input.py +++ b/clive/__private/ui/widgets/inputs/clive_validated_input.py @@ -32,7 +32,13 @@ class CliveValidatedInputError(CliveError): class FailedValidationError(CliveValidatedInputError): - """Raised when validation of `CliveValidatedInput` fails.""" + """ + Raised when validation of `CliveValidatedInput` fails. + + Args: + validation_result: The result of the validation that failed. + input_name: The name of the input that failed validation, if available. + """ def __init__(self, validation_result: ValidationResult, *, input_name: str | None = None) -> None: self.validation_result = validation_result diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 9bbeaf7aa3..c6e257133c 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -440,8 +440,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py DOC502: Method `AssetAmountInput._value` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- clive/__private/ui/widgets/inputs/clive_validated_input.py - DOC101: Method `FailedValidationError.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `FailedValidationError.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [input_name: str | None, validation_result: ValidationResult]. DOC101: Method `FailedManyValidationError.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `FailedManyValidationError.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [errors: list[InputValueError | FailedValidationError]]. DOC101: Method `InputValueError.__init__`: Docstring contains fewer arguments than in function signature. -- GitLab From e350df2b3af49d7e05683c52a69b6f44b3293e3d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:53:39 +0200 Subject: [PATCH 57/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_data_table/CliveDataTableRow.py.refresh_row --- clive/__private/ui/widgets/clive_basic/clive_data_table.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_data_table.py b/clive/__private/ui/widgets/clive_basic/clive_data_table.py index 984365b695..d29e39b6a5 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_data_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_data_table.py @@ -84,7 +84,7 @@ class CliveDataTableRow(Horizontal, CliveWidget): Iterate through the cells and update each of them. Args: - content: The content to update the row with. Must be provided by the DataProvider. + content: The content to update the row with. """ for cell, value in zip(self.cells, self.get_new_values(content), strict=True): cell.update(value) -- GitLab From 21d1df7b995a8522da15f694da659a0f4d4d3ff9 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 18:54:29 +0200 Subject: [PATCH 58/89] Fix pydoclint errors in ui/widgets/clive_basic/clive_data_table/CliveDataTableRow.py.get_new_values --- clive/__private/ui/widgets/clive_basic/clive_data_table.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/widgets/clive_basic/clive_data_table.py b/clive/__private/ui/widgets/clive_basic/clive_data_table.py index d29e39b6a5..e11bd8cfe7 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_data_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_data_table.py @@ -94,7 +94,7 @@ class CliveDataTableRow(Horizontal, CliveWidget): Must be overridden if the `dynamic` parameter is set to True. Args: - content: The content to update the row with. Must be provided by the DataProvider. + content: The content to update the row with. Raises: CliveError: If this method is called on a static row. -- GitLab From e410bec9712676530c7339c1497f195d8dfb9736 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:08:13 +0200 Subject: [PATCH 59/89] Fix pydoclint errors in ui/widgets/inputs/clive_validated_input.py.FailedManyValidationError --- clive/__private/ui/widgets/inputs/clive_validated_input.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index 127234ca15..84ea50f939 100644 --- a/clive/__private/ui/widgets/inputs/clive_validated_input.py +++ b/clive/__private/ui/widgets/inputs/clive_validated_input.py @@ -51,7 +51,12 @@ Input validation failed{additional}. Reasons: class FailedManyValidationError(CliveValidatedInputError): - """Raised when validation of many `CliveValidatedInput` fails.""" + """ + Raised when validation of many `CliveValidatedInput` fails. + + Args: + errors: A list of error instances that caused the failure. + """ def __init__(self, errors: list[InputValueError | FailedValidationError]) -> None: self.errors = errors diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index c6e257133c..00c7379e95 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -440,8 +440,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py DOC502: Method `AssetAmountInput._value` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- clive/__private/ui/widgets/inputs/clive_validated_input.py - DOC101: Method `FailedManyValidationError.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `FailedManyValidationError.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [errors: list[InputValueError | FailedValidationError]]. DOC101: Method `InputValueError.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `InputValueError.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [input_name: str | None, reason: str]. DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body -- GitLab From dbae6acef817cf28debb179c43cb07b1836b7dae Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:08:58 +0200 Subject: [PATCH 60/89] Fix pydoclint errors in ui/widgets/inputs/clive_validated_input.py.InputValueError --- .../__private/ui/widgets/inputs/clive_validated_input.py | 8 +++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index 84ea50f939..73236f4090 100644 --- a/clive/__private/ui/widgets/inputs/clive_validated_input.py +++ b/clive/__private/ui/widgets/inputs/clive_validated_input.py @@ -77,7 +77,13 @@ class FailedManyValidationError(CliveValidatedInputError): class InputValueError(CliveValidatedInputError): - """Raised when cannot get the value of the `CliveValidatedInput`.""" + """ + Raised when cannot get the value of the `CliveValidatedInput`. + + Args: + reason: The reason why the value could not be obtained. + input_name: The name of the input that caused the error, if available. + """ def __init__(self, reason: str, *, input_name: str | None = None) -> None: self.reason = reason diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 00c7379e95..8065a7b153 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -440,8 +440,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py DOC502: Method `AssetAmountInput._value` has a "Raises" section in the docstring, but there are not "raise" statements in the body -------------------- clive/__private/ui/widgets/inputs/clive_validated_input.py - DOC101: Method `InputValueError.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `InputValueError.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [input_name: str | None, reason: str]. DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC101: Method `CliveValidatedInput.validate_with_error`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveValidatedInput.validate_with_error`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [treat_as_required: bool]. -- GitLab From ebb2869f4cc2d8ff8202dd2766c38b78a4e3341c Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:10:05 +0200 Subject: [PATCH 61/89] Fix pydoclint errors in ui/widgets/inputs/clive_validated_input.py.CliveValidatedInput.validate_with_error --- clive/__private/ui/widgets/inputs/clive_validated_input.py | 3 +++ pydoclint-errors-baseline.txt | 2 -- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index 73236f4090..5b47662f74 100644 --- a/clive/__private/ui/widgets/inputs/clive_validated_input.py +++ b/clive/__private/ui/widgets/inputs/clive_validated_input.py @@ -264,6 +264,9 @@ class CliveValidatedInput[InputReturnT](CliveWidget, AbstractClassMessagePump): """ Validate the input and raise an exception if validation fails. + Args: + treat_as_required: Whether to treat the input as required when validating. + Raises: FailedValidationError: Raised when validation fails. InputValueError: Raised when cannot get the input value due to an error, which validation doesn't catch. diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 8065a7b153..150b19f1dd 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -441,8 +441,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py -------------------- clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body - DOC101: Method `CliveValidatedInput.validate_with_error`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveValidatedInput.validate_with_error`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [treat_as_required: bool]. DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. DOC101: Method `CliveValidatedInput.validate_many`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveValidatedInput.validate_many`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [*inputs: CliveValidatedInput[Any], notify_on_validation_error: bool, notify_on_value_error: bool, treat_as_required: bool]. -- GitLab From c9b8f4bbe4593628f1e5dd14ef335b104c58accc Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:10:58 +0200 Subject: [PATCH 62/89] Fix pydoclint errors in ui/widgets/inputs/clive_validated_input.py.CliveValidatedInput.validate_many --- .../ui/widgets/inputs/clive_validated_input.py | 11 +++++++++++ pydoclint-errors-baseline.txt | 3 --- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index 5b47662f74..3ef7966d3a 100644 --- a/clive/__private/ui/widgets/inputs/clive_validated_input.py +++ b/clive/__private/ui/widgets/inputs/clive_validated_input.py @@ -334,6 +334,17 @@ class CliveValidatedInput[InputReturnT](CliveWidget, AbstractClassMessagePump): Validate many inputs and return True if all of them are valid, False otherwise. For more info look into `validate_passed`. + + Args: + *inputs: The inputs to validate. + treat_as_required: Whether to treat the inputs as required when validating. + notify_on_value_error: Whether to show a notification when the input value is invalid. + True by default since this error won't be visible in the UI otherwise. + notify_on_validation_error: Whether to show a notification when the input validation fails. + False by default since the validation error will be visible in the UI, under the input. + + Returns: + True if all inputs are valid, False otherwise. """ results: list[bool] = [ input_obj.validate_passed( diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 150b19f1dd..e6a52fa8f8 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -442,9 +442,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. - DOC101: Method `CliveValidatedInput.validate_many`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveValidatedInput.validate_many`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [*inputs: CliveValidatedInput[Any], notify_on_validation_error: bool, notify_on_value_error: bool, treat_as_required: bool]. - DOC201: Method `CliveValidatedInput.validate_many` does not have a return section in docstring DOC101: Method `CliveValidatedInput.validate_many_with_error`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveValidatedInput.validate_many_with_error`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [*inputs: CliveValidatedInput[Any]]. DOC101: Method `CliveValidatedInput.clear_validation`: Docstring contains fewer arguments than in function signature. -- GitLab From d1ec57b094a6e768d2403f125495f74932e32d9d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:11:27 +0200 Subject: [PATCH 63/89] Fix pydoclint errors in ui/widgets/inputs/clive_validated_input.py.CliveValidatedInput.validate_many_with_error --- clive/__private/ui/widgets/inputs/clive_validated_input.py | 3 +++ pydoclint-errors-baseline.txt | 2 -- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index 3ef7966d3a..71aaf1a7fa 100644 --- a/clive/__private/ui/widgets/inputs/clive_validated_input.py +++ b/clive/__private/ui/widgets/inputs/clive_validated_input.py @@ -362,6 +362,9 @@ class CliveValidatedInput[InputReturnT](CliveWidget, AbstractClassMessagePump): """ Validate many inputs and raise an exception if any of them is invalid. + Args: + *inputs: The inputs to validate. + Raises: FailedManyValidationError: Raised when validation fails. """ diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index e6a52fa8f8..cc6c8c17a0 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -442,8 +442,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. - DOC101: Method `CliveValidatedInput.validate_many_with_error`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveValidatedInput.validate_many_with_error`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [*inputs: CliveValidatedInput[Any]]. DOC101: Method `CliveValidatedInput.clear_validation`: Docstring contains fewer arguments than in function signature. DOC103: Method `CliveValidatedInput.clear_validation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [clear_value: bool]. -------------------- -- GitLab From 05ef45f1f430bb14b7df302c0db1d78ec14af27c Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:11:52 +0200 Subject: [PATCH 64/89] Fix pydoclint errors in ui/widgets/inputs/clive_validated_input.py.CliveValidatedInput.clear_validation --- clive/__private/ui/widgets/inputs/clive_validated_input.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index 71aaf1a7fa..8612160c3a 100644 --- a/clive/__private/ui/widgets/inputs/clive_validated_input.py +++ b/clive/__private/ui/widgets/inputs/clive_validated_input.py @@ -379,7 +379,12 @@ class CliveValidatedInput[InputReturnT](CliveWidget, AbstractClassMessagePump): raise FailedManyValidationError(combined_errors) def clear_validation(self, *, clear_value: bool = True) -> None: - """Clear the validation of the input.""" + """ + Clear the validation of the input. + + Args: + clear_value: Whether to clear the input value as well. + """ self.input.clear_validation(clear_value=clear_value) @on(CliveInput.Validated) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index cc6c8c17a0..aeb4e0e619 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -442,8 +442,6 @@ clive/__private/ui/widgets/inputs/asset_amount_base_input.py clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. - DOC101: Method `CliveValidatedInput.clear_validation`: Docstring contains fewer arguments than in function signature. - DOC103: Method `CliveValidatedInput.clear_validation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [clear_value: bool]. -------------------- clive/__private/ui/widgets/inputs/integer_input.py DOC101: Method `IntegerInput.__init__`: Docstring contains fewer arguments than in function signature. -- GitLab From 5a0fa3680091ca86586ff298becde4c6c149bf1a Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:13:09 +0200 Subject: [PATCH 65/89] Fix pydoclint errors in ui/widgets/inputs/integer_input.py.IntegerInput --- .../ui/widgets/inputs/integer_input.py | 19 ++++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/integer_input.py b/clive/__private/ui/widgets/inputs/integer_input.py index dbc546410f..0d9f134513 100644 --- a/clive/__private/ui/widgets/inputs/integer_input.py +++ b/clive/__private/ui/widgets/inputs/integer_input.py @@ -13,7 +13,24 @@ if TYPE_CHECKING: class IntegerInput(CliveValidatedInput[int]): - """An input for a integer value.""" + """ + An input for a integer value. + + Args: + title: The title of the input. + value: The initial value of the input, can be an integer or None. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + validators: Validators to apply to the input value. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index aeb4e0e619..448039538e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/integer_input.py - DOC101: Method `IntegerInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `IntegerInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | int | None]. --------------------- clive/__private/ui/widgets/inputs/labelized_input.py DOC101: Method `LabelizedInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `LabelizedInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [classes: str | None, id: str | None, title: str, value: str]. -- GitLab From 3e40c42c7a659b63e1b8dfca49186f51e001b5d2 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:13:59 +0200 Subject: [PATCH 66/89] Fix pydoclint errors in ui/widgets/inputs/labelized_input.py.LabelizedInput --- clive/__private/ui/widgets/inputs/labelized_input.py | 10 +++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/labelized_input.py b/clive/__private/ui/widgets/inputs/labelized_input.py index 725d45f586..ac80f89c98 100644 --- a/clive/__private/ui/widgets/inputs/labelized_input.py +++ b/clive/__private/ui/widgets/inputs/labelized_input.py @@ -4,7 +4,15 @@ from clive.__private.ui.widgets.inputs.text_input import TextInput class LabelizedInput(TextInput): - """An input that cannot be edited. It is used to display a static value with same style as other inputs.""" + """ + An input that cannot be edited. It is used to display a static value with same style as other inputs. + + Args: + title: The title of the input. + value: The value to display in the input. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 448039538e..ee8b5c4e11 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/labelized_input.py - DOC101: Method `LabelizedInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `LabelizedInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [classes: str | None, id: str | None, title: str, value: str]. --------------------- clive/__private/ui/widgets/inputs/memo_input.py DOC101: Method `MemoInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `MemoInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. -- GitLab From ee9810e1617c1d893f3f0aee5aefe1ada59458a3 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:14:34 +0200 Subject: [PATCH 67/89] Fix pydoclint errors in ui/widgets/inputs/memo_input.py.MemoInput --- .../__private/ui/widgets/inputs/memo_input.py | 20 ++++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/memo_input.py b/clive/__private/ui/widgets/inputs/memo_input.py index 32058ed115..2218a6c096 100644 --- a/clive/__private/ui/widgets/inputs/memo_input.py +++ b/clive/__private/ui/widgets/inputs/memo_input.py @@ -14,7 +14,25 @@ if TYPE_CHECKING: class MemoInput(TextInput): - """An input for a Hive memo.""" + """ + An input for a Hive memo. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + suggester: An optional suggester for the input. + validators: Validators to apply to the input value. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index ee8b5c4e11..cb275c14a3 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/memo_input.py - DOC101: Method `MemoInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `MemoInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. --------------------- clive/__private/ui/widgets/inputs/password_input.py DOC101: Method `PasswordInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `PasswordInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None]. -- GitLab From e2f05069a2837884ff156181cb220ec9ccceac2b Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:17:44 +0200 Subject: [PATCH 68/89] Fix pydoclint errors in ui/widgets/inputs/password_input.py.PasswordInput --- .../ui/widgets/inputs/password_input.py | 18 +++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/password_input.py b/clive/__private/ui/widgets/inputs/password_input.py index 72823bb73a..ca8e2294bd 100644 --- a/clive/__private/ui/widgets/inputs/password_input.py +++ b/clive/__private/ui/widgets/inputs/password_input.py @@ -12,7 +12,23 @@ if TYPE_CHECKING: class PasswordInput(TextInput): - """An input for entering a Clive password.""" + """ + An input for entering a Clive password. + + Args: + title: The title of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + validators: Validators to apply to the input value. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index cb275c14a3..5817f1cee1 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/password_input.py - DOC101: Method `PasswordInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `PasswordInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None]. --------------------- clive/__private/ui/widgets/inputs/percent_input.py DOC101: Method `PercentInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `PercentInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: DecimalConvertible | None]. -- GitLab From 662b224648296336d43778ea1edcca39c84032be Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:18:43 +0200 Subject: [PATCH 69/89] Fix pydoclint errors in ui/widgets/inputs/percent_input.py.PercentInput --- .../ui/widgets/inputs/percent_input.py | 17 ++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/percent_input.py b/clive/__private/ui/widgets/inputs/percent_input.py index 06015aa2e1..16d9ede113 100644 --- a/clive/__private/ui/widgets/inputs/percent_input.py +++ b/clive/__private/ui/widgets/inputs/percent_input.py @@ -15,7 +15,22 @@ if TYPE_CHECKING: class PercentInput(NumericInput): - """An input for a values between 0.01 and 100.""" + """ + An input for a values between 0.01 and 100. + + Args: + title: The title of the input. + value: The initial value of the input, can be a DecimalConvertible or None. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 5817f1cee1..e196173ddc 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/percent_input.py - DOC101: Method `PercentInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `PercentInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: DecimalConvertible | None]. --------------------- clive/__private/ui/widgets/inputs/private_key_input.py DOC101: Method `PrivateKeyInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `PrivateKeyInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, password: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. -- GitLab From 20d334c8ddd8a30821e0fb47ba2a91d4dec3d1d6 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:19:50 +0200 Subject: [PATCH 70/89] Fix pydoclint errors in ui/widgets/inputs/private_key_input.py.PrivateKeyInput --- .../ui/widgets/inputs/private_key_input.py | 20 ++++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/private_key_input.py b/clive/__private/ui/widgets/inputs/private_key_input.py index 2d1adbf95c..8d6670a2ba 100644 --- a/clive/__private/ui/widgets/inputs/private_key_input.py +++ b/clive/__private/ui/widgets/inputs/private_key_input.py @@ -14,7 +14,25 @@ if TYPE_CHECKING: class PrivateKeyInput(TextInput): - """An input for a public key alias.""" + """ + An input for a public key alias. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + password: Whether the input should be treated as a password (hidden input). + validators: Validators to apply to the input value. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index e196173ddc..0b2175448e 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/private_key_input.py - DOC101: Method `PrivateKeyInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `PrivateKeyInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, password: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. --------------------- clive/__private/ui/widgets/inputs/receiver_input.py DOC101: Method `ReceiverInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `ReceiverInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_bad_account: bool, show_invalid_reasons: bool, show_known_account: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. -- GitLab From 19b73d35efce0bc9d881fd07f93940d47222a9db Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:20:29 +0200 Subject: [PATCH 71/89] Fix pydoclint errors in ui/widgets/inputs/receiver_input.py.ReceiverInput --- .../ui/widgets/inputs/receiver_input.py | 22 ++++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/receiver_input.py b/clive/__private/ui/widgets/inputs/receiver_input.py index 73effcf248..852a058148 100644 --- a/clive/__private/ui/widgets/inputs/receiver_input.py +++ b/clive/__private/ui/widgets/inputs/receiver_input.py @@ -17,7 +17,27 @@ if TYPE_CHECKING: class ReceiverInput(AccountNameInput): - """An input for a receiver that support additionally known exchange accounts.""" + """ + An input for a receiver that support additionally known exchange accounts. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + show_known_account: Whether to show known exchange accounts. + show_bad_account: Whether to show bad accounts. + suggester: A suggester for auto-completion. + validators: Validators to apply to the input value. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ class KnownExchangeDetected(Message): """Sent when a known exchange account is detected in the input.""" diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 0b2175448e..347e4f3d9a 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/receiver_input.py - DOC101: Method `ReceiverInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `ReceiverInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_bad_account: bool, show_invalid_reasons: bool, show_known_account: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. --------------------- clive/__private/ui/widgets/inputs/repeat_password_input.py DOC101: Method `RepeatPasswordInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `RepeatPasswordInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [input_to_repeat: CliveValidatedInput[Any]]. -- GitLab From 3152eaf2d9d62c16da9f1b4237610fea002c4633 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:21:08 +0200 Subject: [PATCH 72/89] Fix pydoclint errors in ui/widgets/inputs/repeat_password_input.py.RepeatPasswordInput --- clive/__private/ui/widgets/inputs/repeat_password_input.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/repeat_password_input.py b/clive/__private/ui/widgets/inputs/repeat_password_input.py index ef63c8eaf5..5c097f4434 100644 --- a/clive/__private/ui/widgets/inputs/repeat_password_input.py +++ b/clive/__private/ui/widgets/inputs/repeat_password_input.py @@ -10,7 +10,12 @@ if TYPE_CHECKING: class RepeatPasswordInput(TextInput): - """Specialized TextInput for repeat password.""" + """ + Specialized TextInput for repeat password. + + Args: + input_to_repeat: The input to repeat the password against. + """ def __init__(self, input_to_repeat: CliveValidatedInput[Any]) -> None: super().__init__( diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 347e4f3d9a..2d8195fd84 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/repeat_password_input.py - DOC101: Method `RepeatPasswordInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `RepeatPasswordInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [input_to_repeat: CliveValidatedInput[Any]]. --------------------- clive/__private/ui/widgets/inputs/set_password_input.py DOC101: Method `SetPasswordInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `SetPasswordInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: str | None]. -- GitLab From 76e79496f4d0bac4cb9eb3900d7d16992e7160c7 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:21:44 +0200 Subject: [PATCH 73/89] Fix pydoclint errors in ui/widgets/inputs/set_password_input.py.SetPasswordInput --- .../ui/widgets/inputs/set_password_input.py | 18 +++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/set_password_input.py b/clive/__private/ui/widgets/inputs/set_password_input.py index 76a5118976..cea452638c 100644 --- a/clive/__private/ui/widgets/inputs/set_password_input.py +++ b/clive/__private/ui/widgets/inputs/set_password_input.py @@ -12,7 +12,23 @@ if TYPE_CHECKING: class SetPasswordInput(TextInput): - """An input for setting a Clive password.""" + """ + An input for setting a Clive password. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 2d8195fd84..0376c4c686 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/set_password_input.py - DOC101: Method `SetPasswordInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `SetPasswordInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: str | None]. --------------------- clive/__private/ui/widgets/inputs/set_profile_name_input.py DOC101: Method `SetProfileNameInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `SetProfileNameInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: str | None]. -- GitLab From 1eed5188d1b11870d71eb98717519cd2b4c61271 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:22:28 +0200 Subject: [PATCH 74/89] Fix pydoclint errors in ui/widgets/inputs/set_profile_name_input.py.SetProfileNameInput --- .../widgets/inputs/set_profile_name_input.py | 18 +++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/set_profile_name_input.py b/clive/__private/ui/widgets/inputs/set_profile_name_input.py index d366fa4305..bd156a346f 100644 --- a/clive/__private/ui/widgets/inputs/set_profile_name_input.py +++ b/clive/__private/ui/widgets/inputs/set_profile_name_input.py @@ -13,7 +13,23 @@ if TYPE_CHECKING: class SetProfileNameInput(TextInput): - """An input for setting a Clive profile name.""" + """ + An input for setting a Clive profile name. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 0376c4c686..db8f19bded 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/set_profile_name_input.py - DOC101: Method `SetProfileNameInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `SetProfileNameInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, placeholder: str, required: bool, show_invalid_reasons: bool, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, value: str | None]. --------------------- clive/__private/ui/widgets/inputs/text_input.py DOC101: Method `TextInput.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `TextInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, password: bool, placeholder: str, required: bool, show_invalid_reasons: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. -- GitLab From fd349218b24a9fbd5e37f9d9245675755501ae7c Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:23:01 +0200 Subject: [PATCH 75/89] Fix pydoclint errors in ui/widgets/inputs/text_input.py.TextInput --- .../__private/ui/widgets/inputs/text_input.py | 21 ++++++++++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/inputs/text_input.py b/clive/__private/ui/widgets/inputs/text_input.py index 8c0f64a964..76b96b0aa6 100644 --- a/clive/__private/ui/widgets/inputs/text_input.py +++ b/clive/__private/ui/widgets/inputs/text_input.py @@ -13,7 +13,26 @@ if TYPE_CHECKING: class TextInput(CliveValidatedInput[str]): - """An input for a text value.""" + """ + An input for a text value. + + Args: + title: The title of the input. + value: The initial value of the input. + placeholder: The placeholder text for the input. + always_show_title: Whether to always show the title. + include_title_in_placeholder_when_blurred: Whether to include the title when the input is blurred. + show_invalid_reasons: Whether to show reasons for invalid input. + required: Whether the input is required. + password: Whether the input should be treated as a password (hidden input). + suggester: A suggester for autocompletion. + validators: Validators to apply to the input value. + validate_on: When to validate the input. + valid_empty: Whether the input can be valid when empty. + id: The ID of the input widget. + classes: Additional CSS classes for the input. + disabled: Whether the input is disabled. + """ def __init__( self, diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index db8f19bded..232a86ed0d 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -443,10 +443,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC502: Method `CliveValidatedInput.value_or_error` has a "Raises" section in the docstring, but there are not "raise" statements in the body DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- -clive/__private/ui/widgets/inputs/text_input.py - DOC101: Method `TextInput.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `TextInput.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [always_show_title: bool, classes: str | None, disabled: bool, id: str | None, include_title_in_placeholder_when_blurred: bool, password: bool, placeholder: str, required: bool, show_invalid_reasons: bool, suggester: Suggester | None, title: str, valid_empty: bool, validate_on: Iterable[InputValidationOn] | None, validators: Validator | Iterable[Validator] | None, value: str | None]. --------------------- clive/__private/ui/widgets/known_exchange_handler.py DOC601: Class `KnownExchangeHandler`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `KnownExchangeHandler`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , MEMO_REQUIRED_VALIDATION_MESSAGE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From f6f8665cdfcd3ae7bb6bf9d62173501ef08848bb Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:24:13 +0200 Subject: [PATCH 76/89] Fix pydoclint errors in ui/widgets/known_exchange_handler.py.KnownExchangeHandler --- .../__private/ui/widgets/known_exchange_handler.py | 14 ++++++++------ pydoclint-errors-baseline.txt | 2 -- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/clive/__private/ui/widgets/known_exchange_handler.py b/clive/__private/ui/widgets/known_exchange_handler.py index 9755cbb7f1..20bbdc59d0 100644 --- a/clive/__private/ui/widgets/known_exchange_handler.py +++ b/clive/__private/ui/widgets/known_exchange_handler.py @@ -19,12 +19,14 @@ class KnownExchangeHandler(CliveWidget): The widget responds to messages: `KnownExchangeDetected` and `KnownExchangeGone` emitted by KnownExchangeInput`. Automatically disables/enables the selector from `LiquidAssetAmountInput` and makes memo input required. - Notice - ______ - - For the handler to work properly, you must also use `KnownExchangeInput`! - Handler is designed to be used as a context manager, and the input must be placed under - the with statement with the handler. + Notice: + For the handler to work properly, you must also use `KnownExchangeInput`! + Handler is designed to be used as a context manager, and the input must be placed under + the with statement with the handler. + + Attributes: + DEFAULT_CSS: Default CSS styles for the widget. + MEMO_REQUIRED_VALIDATION_MESSAGE: Message shown when memo is required by the known exchange account. """ DEFAULT_CSS = """ diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 232a86ed0d..7a2fda62df 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -444,8 +444,6 @@ clive/__private/ui/widgets/inputs/clive_validated_input.py DOC503: Method `CliveValidatedInput.validate_with_error` exceptions in the "Raises" section in the docstring do not match those in the function body. Raised exceptions in the docstring: ['FailedValidationError', 'InputValueError']. Raised exceptions in the body: ['FailedValidationError']. -------------------- clive/__private/ui/widgets/known_exchange_handler.py - DOC601: Class `KnownExchangeHandler`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `KnownExchangeHandler`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , MEMO_REQUIRED_VALIDATION_MESSAGE: Final[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `KnownExchangeHandler._change_selector_state`: Docstring contains fewer arguments than in function signature. DOC103: Method `KnownExchangeHandler._change_selector_state`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [disable: bool]. DOC101: Method `KnownExchangeHandler._change_memo_requirement`: Docstring contains fewer arguments than in function signature. -- GitLab From 3375ebf271234acce558a8641917d1ea40a7961b Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:25:10 +0200 Subject: [PATCH 77/89] Fix pydoclint errors in ui/widgets/location_indicator.py.LocationIndicator --- clive/__private/ui/widgets/location_indicator.py | 11 ++++++++++- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/widgets/location_indicator.py b/clive/__private/ui/widgets/location_indicator.py index e04599ae89..07a26af14d 100644 --- a/clive/__private/ui/widgets/location_indicator.py +++ b/clive/__private/ui/widgets/location_indicator.py @@ -17,7 +17,16 @@ class SubTitle(Static): class LocationIndicator(Vertical): - """A widget that can be used to display a user's location in the app with a big title and subtitle.""" + """ + A widget that can be used to display a user's location in the app with a big title and subtitle. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + + Args: + big_title: The main title to display prominently. + subtitle: An optional subtitle to provide additional context. + """ DEFAULT_CSS = """ LocationIndicator { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 7a2fda62df..dc01e9c82d 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -449,12 +449,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC101: Method `KnownExchangeHandler._change_memo_requirement`: Docstring contains fewer arguments than in function signature. DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- -clive/__private/ui/widgets/location_indicator.py - DOC601: Class `LocationIndicator`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `LocationIndicator`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `LocationIndicator.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `LocationIndicator.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [big_title: str, subtitle: RenderableType]. --------------------- clive/__private/ui/widgets/node_widgets.py DOC601: Class `SelectedNodeAddress`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `SelectedNodeAddress`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [node_address: HttpUrl | None]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From b5850fdc264463a29266a0827e530e091f356a41 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:25:58 +0200 Subject: [PATCH 78/89] Fix pydoclint errors in ui/widgets/node_widgets.py.SelectedNodeAddress --- clive/__private/ui/widgets/node_widgets.py | 11 ++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/node_widgets.py b/clive/__private/ui/widgets/node_widgets.py index 96db156a09..f968d8294e 100644 --- a/clive/__private/ui/widgets/node_widgets.py +++ b/clive/__private/ui/widgets/node_widgets.py @@ -18,7 +18,16 @@ if TYPE_CHECKING: class SelectedNodeAddress(Static): - """The currently selected node address.""" + """ + The currently selected node address. + + Attributes: + node_address: The address of the currently selected node. If changed - displayed text will be automatically + updated. + + Args: + node_address: The address of the node to display. + """ node_address: HttpUrl | None = reactive(None) # type: ignore[assignment] diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index dc01e9c82d..7846027e0c 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -450,10 +450,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- clive/__private/ui/widgets/node_widgets.py - DOC601: Class `SelectedNodeAddress`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `SelectedNodeAddress`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [node_address: HttpUrl | None]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `SelectedNodeAddress.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `SelectedNodeAddress.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [node_address: HttpUrl]. DOC601: Class `NodesList`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `NodesList`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -------------------- -- GitLab From 60097634c6878899f112f4cc4e967cd5b7c1c73f Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:26:28 +0200 Subject: [PATCH 79/89] Fix pydoclint errors in ui/widgets/node_widgets.py.NodesList --- clive/__private/ui/widgets/node_widgets.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/node_widgets.py b/clive/__private/ui/widgets/node_widgets.py index f968d8294e..9c232bba15 100644 --- a/clive/__private/ui/widgets/node_widgets.py +++ b/clive/__private/ui/widgets/node_widgets.py @@ -51,7 +51,12 @@ class NodeSelector(CliveSelect[HttpUrl], CliveWidget): class NodesList(Container, CliveWidget): - """Container for the list of nodes to choose with method to save given address.""" + """ + Container for the list of nodes to choose with method to save given address. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + """ DEFAULT_CSS = """ NodesList { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 7846027e0c..cd6d7b641b 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -449,10 +449,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC101: Method `KnownExchangeHandler._change_memo_requirement`: Docstring contains fewer arguments than in function signature. DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- -clive/__private/ui/widgets/node_widgets.py - DOC601: Class `NodesList`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `NodesList`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/widgets/place_taker.py DOC601: Class `PlaceTaker`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `PlaceTaker`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From 2f2c1d80260a1d2455185a5505b66c85f7588ce4 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:27:07 +0200 Subject: [PATCH 80/89] Fix pydoclint errors in ui/widgets/place_taker.py.PlaceTaker --- clive/__private/ui/widgets/place_taker.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/place_taker.py b/clive/__private/ui/widgets/place_taker.py index bcdb0e7445..19aee437cc 100644 --- a/clive/__private/ui/widgets/place_taker.py +++ b/clive/__private/ui/widgets/place_taker.py @@ -4,7 +4,12 @@ from textual.widgets import Static class PlaceTaker(Static): - """A widget that takes up space but does not render anything.""" + """ + A widget that takes up space but does not render anything. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + """ DEFAULT_CSS = """ PlaceTaker { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index cd6d7b641b..4e2629ca98 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -449,10 +449,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC101: Method `KnownExchangeHandler._change_memo_requirement`: Docstring contains fewer arguments than in function signature. DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- -clive/__private/ui/widgets/place_taker.py - DOC601: Class `PlaceTaker`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `PlaceTaker`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) --------------------- clive/__private/ui/widgets/section.py DOC601: Class `SectionBody`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `SectionBody`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) -- GitLab From edcac44f70401fc3aec6f3ea1b4fe0924898c53d Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:27:56 +0200 Subject: [PATCH 81/89] Fix pydoclint errors in ui/widgets/section.py.SectionBody --- clive/__private/ui/widgets/section.py | 7 ++++++- pydoclint-errors-baseline.txt | 2 -- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/clive/__private/ui/widgets/section.py b/clive/__private/ui/widgets/section.py index da4ee84b1e..c83d2aa4e0 100644 --- a/clive/__private/ui/widgets/section.py +++ b/clive/__private/ui/widgets/section.py @@ -13,7 +13,12 @@ if TYPE_CHECKING: class SectionBody(Container): - """A container for the body of the section.""" + """ + A container for the body of the section. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + """ DEFAULT_CSS = """ SectionBody { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 4e2629ca98..afbca523ae 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -450,8 +450,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- clive/__private/ui/widgets/section.py - DOC601: Class `SectionBody`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `SectionBody`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC601: Class `Section`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `Section`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `Section.__init__`: Docstring contains fewer arguments than in function signature. -- GitLab From 45840f7d7b6b196eb9e74bb5ffa434d125fb8414 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:28:23 +0200 Subject: [PATCH 82/89] Fix pydoclint errors in ui/widgets/section.py.Section --- clive/__private/ui/widgets/section.py | 12 +++++++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/section.py b/clive/__private/ui/widgets/section.py index c83d2aa4e0..21df725054 100644 --- a/clive/__private/ui/widgets/section.py +++ b/clive/__private/ui/widgets/section.py @@ -30,7 +30,17 @@ class SectionBody(Container): class Section(Container): - """Container with predefined background padding and optionally added SectionTitle.""" + """ + Container with predefined background padding and optionally added title. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + + Args: + title: The title of the section, if any. + id_: The ID of the section widget. + classes: Additional CSS classes for the section. + """ DEFAULT_CSS = """ Section { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index afbca523ae..37d24867b8 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -450,10 +450,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- clive/__private/ui/widgets/section.py - DOC601: Class `Section`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `Section`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `Section.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `Section.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [classes: str | None, id_: str | None, title: str | None]. DOC601: Class `SectionScrollable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `SectionScrollable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `SectionScrollable.__init__`: Docstring contains fewer arguments than in function signature. -- GitLab From d01d6452407145ce5c70a5c2ddf0a97102326d69 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:28:51 +0200 Subject: [PATCH 83/89] Fix pydoclint errors in ui/widgets/section.py.SectionScrollable --- clive/__private/ui/widgets/section.py | 13 ++++++++++++- pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/clive/__private/ui/widgets/section.py b/clive/__private/ui/widgets/section.py index 21df725054..f0424573fb 100644 --- a/clive/__private/ui/widgets/section.py +++ b/clive/__private/ui/widgets/section.py @@ -64,7 +64,18 @@ class Section(Container): class SectionScrollable(Section): - """Scrollable version of section container.""" + """ + Scrollable version of section container. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + + Args: + title: The title of the section, if any. + id_: The ID of the section widget. + classes: Additional CSS classes for the section. + focusable: Whether the section should be focusable. + """ DEFAULT_CSS = """ SectionScrollable { diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 37d24867b8..59c7cb63bb 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -449,12 +449,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC101: Method `KnownExchangeHandler._change_memo_requirement`: Docstring contains fewer arguments than in function signature. DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- -clive/__private/ui/widgets/section.py - DOC601: Class `SectionScrollable`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `SectionScrollable`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `SectionScrollable.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `SectionScrollable.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [classes: str | None, focusable: bool, id_: str | None, title: str | None]. --------------------- clive/__private/ui/widgets/select/safe_select.py DOC101: Method `SingleSelect.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `SingleSelect.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [option: SelectOption[SelectType]]. -- GitLab From 3962ed399e42361283d5b2b270f3975a8a876d3e Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:29:48 +0200 Subject: [PATCH 84/89] Fix pydoclint errors in ui/widgets/select/safe_select.py.SingleSelect --- clive/__private/ui/widgets/select/safe_select.py | 7 ++++++- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/clive/__private/ui/widgets/select/safe_select.py b/clive/__private/ui/widgets/select/safe_select.py index 663ce7b1de..2a437a6a8a 100644 --- a/clive/__private/ui/widgets/select/safe_select.py +++ b/clive/__private/ui/widgets/select/safe_select.py @@ -29,7 +29,12 @@ class EmptySelect(Static): class SingleSelect(Static, Generic[SelectType]): # noqa: UP046 - """Dummy select widget.""" + """ + Dummy select widget. + + Args: + option: The single option that will be just displayed without any interaction. + """ def __init__(self, option: SelectOption[SelectType]) -> None: super().__init__(option[0]) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 59c7cb63bb..4c608ac073 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -449,10 +449,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC101: Method `KnownExchangeHandler._change_memo_requirement`: Docstring contains fewer arguments than in function signature. DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- -clive/__private/ui/widgets/select/safe_select.py - DOC101: Method `SingleSelect.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `SingleSelect.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [option: SelectOption[SelectType]]. --------------------- clive/__private/ui/widgets/switch_working_account_container.py DOC101: Method `NoWorkingAccountRadioButton.__init__`: Docstring contains fewer arguments than in function signature. DOC103: Method `NoWorkingAccountRadioButton.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [value: bool]. -- GitLab From f0c1f46625d96162ff5b2b50d3dab2b6f2bd71ae Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:30:32 +0200 Subject: [PATCH 85/89] Fix pydoclint errors in ui/widgets/switch_working_account_container.py.NoWorkingAccountRadioButton --- clive/__private/ui/widgets/switch_working_account_container.py | 3 +++ pydoclint-errors-baseline.txt | 2 -- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/clive/__private/ui/widgets/switch_working_account_container.py b/clive/__private/ui/widgets/switch_working_account_container.py index 597616b66b..03d5d75373 100644 --- a/clive/__private/ui/widgets/switch_working_account_container.py +++ b/clive/__private/ui/widgets/switch_working_account_container.py @@ -50,6 +50,9 @@ class NoWorkingAccountRadioButton(CliveRadioButton): Button is created because the textual `RadioSet` does not support deselecting radio buttons and situations where there are no radio buttons selected. This approach is not ideal, but this way we do not have to change the `RadioSet` code. + + Args: + value: Whether this button is selected or not. """ def __init__(self, *, value: bool) -> None: diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 4c608ac073..8471cadb42 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -450,8 +450,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- clive/__private/ui/widgets/switch_working_account_container.py - DOC101: Method `NoWorkingAccountRadioButton.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `NoWorkingAccountRadioButton.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [value: bool]. DOC601: Class `SwitchWorkingAccountContainer`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC603: Class `SwitchWorkingAccountContainer`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , local_profile: Profile]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) DOC101: Method `SwitchWorkingAccountContainer.__init__`: Docstring contains fewer arguments than in function signature. -- GitLab From 281e713fd9d163b63ae8f5e4aae24a1d32e49498 Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:31:23 +0200 Subject: [PATCH 86/89] Fix pydoclint errors in ui/widgets/switch_working_account_container.py.SwitchWorkingAccountContainer --- .../ui/widgets/switch_working_account_container.py | 12 ++++++++++-- pydoclint-errors-baseline.txt | 4 ---- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/clive/__private/ui/widgets/switch_working_account_container.py b/clive/__private/ui/widgets/switch_working_account_container.py index 03d5d75373..e552182ebe 100644 --- a/clive/__private/ui/widgets/switch_working_account_container.py +++ b/clive/__private/ui/widgets/switch_working_account_container.py @@ -76,12 +76,20 @@ def get_default_profile() -> Profile: class SwitchWorkingAccountContainer(Container, CliveWidget): - """Container that displays all tracked accounts (working + watched) and allows to switch between them.""" + """ + Container that displays all tracked accounts (working + watched) and allows to switch between them. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + local_profile: Reactive to provide a single state of profile across the widget. + + Args: + show_title: Whether to show the title or not. + """ DEFAULT_CSS = get_css_from_relative_path(__file__) local_profile: Profile = var(get_default_profile, init=False) # type: ignore[assignment, arg-type] - """Reactive to provide a single state of profile across the widget.""" def __init__(self, *, show_title: bool = True) -> None: super().__init__() diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index 8471cadb42..c22e706134 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -450,10 +450,6 @@ clive/__private/ui/widgets/known_exchange_handler.py DOC103: Method `KnownExchangeHandler._change_memo_requirement`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [required: bool]. -------------------- clive/__private/ui/widgets/switch_working_account_container.py - DOC601: Class `SwitchWorkingAccountContainer`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `SwitchWorkingAccountContainer`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: , local_profile: Profile]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `SwitchWorkingAccountContainer.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `SwitchWorkingAccountContainer.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [show_title: bool]. DOC101: Method `SwitchWorkingAccountContainer._create_radio_buttons`: Docstring contains fewer arguments than in function signature. DOC103: Method `SwitchWorkingAccountContainer._create_radio_buttons`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [profile: Profile]. DOC201: Method `SwitchWorkingAccountContainer._create_radio_buttons` does not have a return section in docstring -- GitLab From bed94f5ea69e1017ae2fc2489f8185301796427f Mon Sep 17 00:00:00 2001 From: Dawid Nocinski Date: Sun, 20 Jul 2025 19:33:02 +0200 Subject: [PATCH 87/89] Fix pydoclint errors in ui/widgets/titled_label.py.TitledLabel --- clive/__private/ui/widgets/titled_label.py | 14 ++++++++++++++ pydoclint-errors-baseline.txt | 6 ------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/clive/__private/ui/widgets/titled_label.py b/clive/__private/ui/widgets/titled_label.py index 77abc04a36..153cd432ba 100644 --- a/clive/__private/ui/widgets/titled_label.py +++ b/clive/__private/ui/widgets/titled_label.py @@ -30,6 +30,20 @@ class TitledLabel(CliveWidget): The value can be updated dynamically if :obj_to_watch: and :attribute_name: is given. When :value: is provided with both of the mentioned parameters, it will be used as a prefix for the dynamic value. + + Attributes: + DEFAULT_CSS: The default CSS styles for the widget. + + Args: + title: The title of the label. + value: The initial value of the label. + obj_to_watch: An object to watch for changes in the specified attribute. + attribute_name: The name of the attribute to watch for changes. + callback: A callback function to call when the value changes. + first_try_callback: A callback function to call on the first try of rendering. + init: Whether to initialize the dynamic label immediately. + id_: The ID of the widget. + shrink: Whether to shrink the label to fit its content. """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/pydoclint-errors-baseline.txt b/pydoclint-errors-baseline.txt index c22e706134..891d8ce2ac 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -456,12 +456,6 @@ clive/__private/ui/widgets/switch_working_account_container.py DOC101: Method `SwitchWorkingAccountContainer._handle_selected_account_changed`: Docstring contains fewer arguments than in function signature. DOC103: Method `SwitchWorkingAccountContainer._handle_selected_account_changed`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [profile: Profile]. -------------------- -clive/__private/ui/widgets/titled_label.py - DOC601: Class `TitledLabel`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC603: Class `TitledLabel`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [DEFAULT_CSS: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.) - DOC101: Method `TitledLabel.__init__`: Docstring contains fewer arguments than in function signature. - DOC103: Method `TitledLabel.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [attribute_name: str | None, callback: DynamicLabelCallbackType | None, first_try_callback: DynamicWidgetFirstTryCallbackType, id_: str | None, init: bool, obj_to_watch: Reactable | None, shrink: bool, title: RenderableType, value: str]. --------------------- clive/__private/validators/exchange_operations_validator.py DOC101: Method `ExchangeOperationsValidator._validate_hbd_transfer_operation`: Docstring contains fewer arguments than in function signature. DOC103: Method `ExchangeOperationsValidator._validate_hbd_transfer_operation`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [value: str]. -- GitLab From fc760f1ec0d96f79498cc2889b6724f47de79ace Mon Sep 17 00:00:00 2001 From: Mateusz Kudela Date: Wed, 23 Jul 2025 12:17:01 +0000 Subject: [PATCH 88/89] Correct docstring in PrivateKeyInput --- clive/__private/ui/widgets/inputs/private_key_input.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clive/__private/ui/widgets/inputs/private_key_input.py b/clive/__private/ui/widgets/inputs/private_key_input.py index 8d6670a2ba..bc51755072 100644 --- a/clive/__private/ui/widgets/inputs/private_key_input.py +++ b/clive/__private/ui/widgets/inputs/private_key_input.py @@ -15,7 +15,7 @@ if TYPE_CHECKING: class PrivateKeyInput(TextInput): """ - An input for a public key alias. + An input for a private key. Args: title: The title of the input. -- GitLab From cf46034da30dd26ce3cf9662618e5104c87158b5 Mon Sep 17 00:00:00 2001 From: Mateusz Kudela Date: Fri, 25 Jul 2025 13:07:48 +0000 Subject: [PATCH 89/89] Correct docstrings in governance_actions and governance_table --- .../common_governance/governance_actions.py | 2 +- .../governance_operations/common_governance/governance_table.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_actions.py b/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_actions.py index 97a43d3cbf..160628a075 100644 --- a/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_actions.py +++ b/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_actions.py @@ -31,7 +31,7 @@ class GovernanceActionRow(Horizontal, AbstractClassMessagePump): Args: identifier: Used to pass the identifier of the action. It is used to create id of the widget. - vote: Action to be performed - vote or not. + vote: Action to be performed - vote or unvote. """ DEFAULT_CSS = get_css_from_relative_path(__file__) diff --git a/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_table.py b/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_table.py index 5eadac22f4..69725420cc 100644 --- a/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_table.py +++ b/clive/__private/ui/screens/operations/governance_operations/common_governance/governance_table.py @@ -132,7 +132,7 @@ class GovernanceTableRow(Grid, CliveWidget, Generic[GovernanceDataT], AbstractCl Attributes: action_identifier: Identifier of the action to be performed, e.g. witness name or proposal id. - vote: Action to be performed - vote or not. + vote: Action to be performed - vote or unvote. add: Indicates if the action should be added to the actions container or removed. """ -- GitLab