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 97a43d3cbf9fb456f1d3813afc826e60267ca427..160628a0758e5a80a21bb268f5793c3e12f147b9 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 5eadac22f411771fcd47e597f6faac60d2d96e03..69725420cceb6d7bcf9e9453785a6053f6141355 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. """ 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 c12be107d65be2c630e2db547e7ec7523c88bd83..aadf0b6c4826abf995afb9b0114e48a73f3c72ce 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/clive/__private/ui/screens/operations/governance_operations/witness/witness.py b/clive/__private/ui/screens/operations/governance_operations/witness/witness.py index c13c3c0ab7196ac96244a3d7d0fd6862b2c804f5..5945e9536f6c59d5d8e8e534850a83aca09f6859 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__( @@ -78,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")] @@ -122,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 @@ -251,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/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 3bca78a2411d0bf8857d44de7812ae3426ff2c15..5aa443c161e98d23da801f675b9e1a708b828c63 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/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 de4629d571e1b798d380b3cd51b95775ea39bf6c..1bf0e6ad08670cd80193007229c5dd40c8d6f182 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" @@ -102,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/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 93dc45ec396b30fff4659c317e00d191805de3b8..90aed22a44816b9a81d95a07604a677d197e20ae 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/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 139cfd4b3903c87a9f641d4e3a9481044132bb3d..c7c37bf7f3d08a099ce3dd112d6865473fa0d9c2 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/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 902e1a1a4df10533c464d26b9d379620c2ba1d88..9e8ba97b3c3b2faf25aa8da4ab408bd9df4324b0 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 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" @@ -106,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 tab pane. + 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/clive/__private/ui/screens/settings/account_management/bad_accounts.py b/clive/__private/ui/screens/settings/account_management/bad_accounts.py index 0c4f896b8b0d270cbd4296bb39f94e0871c13207..df7cb573537d8b2eb18779632ca119bcb95007f8 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 { @@ -144,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 tab pane. + TITLE: Title of the BadAccounts tab pane. + """ DEFAULT_CSS = """ BadAccounts { 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 472a0cea41d8f2b6be1fe811cfa36ffe228caebe..60b85c6732c0a09faf23e0a41b7f0958914dccf1 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/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 9c8d4afa51065db7c1ed928b3607df9538f246d9..81379fc15c5c611b2244f992e3e5b0db195fe288 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 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/clive/__private/ui/screens/settings/account_management/known_accounts.py b/clive/__private/ui/screens/settings/account_management/known_accounts.py index 390a44b7a452386814544be6962fe6225728a4a1..85bd9c96fc822a5ce583c4dfbfa96d8bbeb4abdd 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/clive/__private/ui/screens/settings/account_management/tracked_accounts.py b/clive/__private/ui/screens/settings/account_management/tracked_accounts.py index 415320272d0e9c42376ea9695816d29fef0b8c82..30af3112ba9ad1898a801941e9a463987f71b312 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/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 33be3d1d8cabf9d98ee38e3b5876d2967308782c..85424f7a2ff07868b3e5ef3a0320c9e4103e7811 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 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/clive/__private/ui/screens/transaction_summary/cart_table.py b/clive/__private/ui/screens/transaction_summary/cart_table.py index cdd335ea6f3b36f77b6420d3a99b81d5bd1720dc..ddc1abb677b5110f2a3757ae1b65002d149e7de7 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) @@ -257,13 +267,23 @@ 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" @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/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py b/clive/__private/ui/screens/transaction_summary/transaction_metadata_container.py index d4e4aac875cbd92708b54b3333c70e5359109e23..d8dc515d9f4e23e5ecedec668bc079567b23d954 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. + """ 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. + """ transaction_id: str = reactive(None, init=False) # type: ignore[assignment] diff --git a/clive/__private/ui/screens/transaction_summary/transaction_summary.py b/clive/__private/ui/screens/transaction_summary/transaction_summary.py index 78c51ba3478fea0c7f358bfac7965810f454f963..c7bba862843281ff93abdc8d0ed0d25b084c94f7 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/clive/__private/ui/widgets/buttons/clive_button.py b/clive/__private/ui/widgets/buttons/clive_button.py index 0f659e144e631d96b874cd3f9a51c20c17a6d257..fd361d0b1d6947c0c4c492165f442c2855fad837 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.""" @@ -136,15 +152,26 @@ 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() 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/clive/__private/ui/widgets/buttons/generous_button.py b/clive/__private/ui/widgets/buttons/generous_button.py index b02f7ce2c1559b46a5bfc688aa0b2997942fe32b..c289f8d1b32b6d6df9e8842d2832b4f4707a0503 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/clive/__private/ui/widgets/buttons/one_line_button.py b/clive/__private/ui/widgets/buttons/one_line_button.py index 566fd4a1f48a93b79c7f1f55c8bdb4b19e7e8e4b..a19fe59e8ea4c1ac59f31d625652e4ec2352bf45 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/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py b/clive/__private/ui/widgets/clive_basic/clive_checkerboard_table.py index d245fa1828df75dcb9197fa32a0442f1b34597fa..1c2b758a6146f85d5d0aaf391dff19bce97ac744 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: @@ -343,13 +344,23 @@ 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)) 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() @@ -404,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 row instances to be displayed in the table. """ if self.should_be_dynamic: raise InvalidDynamicDefinedError @@ -417,6 +434,9 @@ class CliveCheckerboardTable(CliveWidget): Raises: InvalidStaticDefinedError: When ATTRIBUTE_TO_WATCH has not been set without overriding the method. + + Returns: + A sequence of row instances to be displayed in the table. """ if not self.should_be_dynamic: raise InvalidStaticDefinedError @@ -469,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 @@ -477,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/clive/__private/ui/widgets/clive_basic/clive_data_table.py b/clive/__private/ui/widgets/clive_basic/clive_data_table.py index 87078a60c08f5c44f1733f6c1970b00eaa7a293f..e11bd8cfe70376c1e533a3b06e070466afc0028b 100644 --- a/clive/__private/ui/widgets/clive_basic/clive_data_table.py +++ b/clive/__private/ui/widgets/clive_basic/clive_data_table.py @@ -80,12 +80,28 @@ 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. + """ for cell, value in zip(self.cells, self.get_new_values(content), strict=True): 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. + + 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/clive/__private/ui/widgets/clive_basic/clive_header.py b/clive/__private/ui/widgets/clive_basic/clive_header.py index 42cdc9394bbfb64eb985a16361c6362551825960..fd824fea1c6ae296d21471037847b1eebbb94ce3 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/clive/__private/ui/widgets/clive_basic/clive_radio_button.py b/clive/__private/ui/widgets/clive_basic/clive_radio_button.py index 16473bb0c24571d84d4903abde316978d7ea1390..7957d63fedb9a71c64829903527202ca67efad3f 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/clive/__private/ui/widgets/dialog_container.py b/clive/__private/ui/widgets/dialog_container.py index 8fdcd747a15aa13a3593d8847ba3892b013402d9..156c2837cfd5084d4ec24b16c77619612bf163e1 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/clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py b/clive/__private/ui/widgets/dynamic_widgets/dynamic_widget.py index e53428a45a0da5e057a11fdec96cc75300083f15..626af1af6768718ebc550ed3c513a5630804cb4a 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/clive/__private/ui/widgets/ellipsed_static.py b/clive/__private/ui/widgets/ellipsed_static.py index c1f385cb62403a8fa407a12e21d28c64eea6b3e6..0344adc66d8a54f10f5f9e774c908385c442eefc 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/clive/__private/ui/widgets/inputs/account_name_pattern_input.py b/clive/__private/ui/widgets/inputs/account_name_pattern_input.py index 2028b017b25eb2aa896e42b1f24f326feb8c1098..7a41fd1480c6453b5df252d2c332265f6864573b 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/clive/__private/ui/widgets/inputs/authority_filter_input.py b/clive/__private/ui/widgets/inputs/authority_filter_input.py index fd6973b379cb665940b65fce1036c0e318352c83..3a5ec82895bab262978c685e3c3de582c37c2fc7 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/clive/__private/ui/widgets/inputs/clive_input.py b/clive/__private/ui/widgets/inputs/clive_input.py index 8482cd4504c2afab733d271ade860a96487d33d6..f1e50c4b3c8facbf0acffa24c40c55053637bc18 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() @@ -213,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/clive/__private/ui/widgets/inputs/clive_validated_input.py b/clive/__private/ui/widgets/inputs/clive_validated_input.py index be4304534c7baff243e893861a3df6651f8c5f20..8612160c3ac52aa1545833498e14952a81e15bb0 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 @@ -45,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 @@ -66,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 @@ -247,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. @@ -314,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( @@ -331,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. """ @@ -345,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/clive/__private/ui/widgets/inputs/integer_input.py b/clive/__private/ui/widgets/inputs/integer_input.py index dbc546410f4526c86612f135a8448936fad428f2..0d9f134513ef3254b3dbfaa554aa1b14642c7ae4 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/clive/__private/ui/widgets/inputs/labelized_input.py b/clive/__private/ui/widgets/inputs/labelized_input.py index 725d45f586bca0111ea259179382cc0074801c24..ac80f89c98a7f63339e6054ee4b1374f8cdd81f3 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/clive/__private/ui/widgets/inputs/memo_input.py b/clive/__private/ui/widgets/inputs/memo_input.py index 32058ed115790c8baf6bb150f086818425b5b4fe..2218a6c0963d69f9ee712dc2771e2b6978a4add1 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/clive/__private/ui/widgets/inputs/password_input.py b/clive/__private/ui/widgets/inputs/password_input.py index 72823bb73a1744ec7488dab46c33d24dab00c1b8..ca8e2294bdbd20f83ffac5cfee608f4de49644bb 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/clive/__private/ui/widgets/inputs/percent_input.py b/clive/__private/ui/widgets/inputs/percent_input.py index 06015aa2e19ecb5bf02bfa817ab35c3433bf997e..16d9ede113b1c60a1a3bb61d17b9a42b6600760b 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/clive/__private/ui/widgets/inputs/private_key_input.py b/clive/__private/ui/widgets/inputs/private_key_input.py index 2d1adbf95cf1fe606468af360b5ac4853d1a6c25..bc51755072690be30bcebb908e4905800057a1e8 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 private key. + + 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/clive/__private/ui/widgets/inputs/receiver_input.py b/clive/__private/ui/widgets/inputs/receiver_input.py index 73effcf248757683b8684a3ebdd0a19ffa3d544b..852a0581487809df7e8c5b3ca0708231fb59130d 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/clive/__private/ui/widgets/inputs/repeat_password_input.py b/clive/__private/ui/widgets/inputs/repeat_password_input.py index ef63c8eaf5dc6c77fa7fb1f23add4361721d7664..5c097f443413f6d49fd888d74361dda7e434531d 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/clive/__private/ui/widgets/inputs/set_password_input.py b/clive/__private/ui/widgets/inputs/set_password_input.py index 76a5118976cde3f3cb6921f1ecced7f36e74d957..cea452638c7f37e4b4bc452203347e7177ab6d57 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/clive/__private/ui/widgets/inputs/set_profile_name_input.py b/clive/__private/ui/widgets/inputs/set_profile_name_input.py index d366fa43051c6179f0190e6ee4b85ac4b6eb7de1..bd156a346f96e2b2ddbbff82db05daad6916b564 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/clive/__private/ui/widgets/inputs/text_input.py b/clive/__private/ui/widgets/inputs/text_input.py index 8c0f64a9645d2b9f6a06858cdc0d671e16766462..76b96b0aa624d5ce35122e1d6a1cfe1e118999c7 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/clive/__private/ui/widgets/known_exchange_handler.py b/clive/__private/ui/widgets/known_exchange_handler.py index 9755cbb7f17e55d38409c6c0303d90a2fecd8fa7..20bbdc59d020cef0cb3633cf35589441d61a4898 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/clive/__private/ui/widgets/location_indicator.py b/clive/__private/ui/widgets/location_indicator.py index e04599ae89b0a6332bce46850df29f445dc0b9fa..07a26af14daf16864cdef751a222fa2e7a5841ca 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/clive/__private/ui/widgets/node_widgets.py b/clive/__private/ui/widgets/node_widgets.py index 96db156a09716ba8ce7090de81872389f3fdde6e..9c232bba155e9b650e626f1f9857b9a3fa377a03 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] @@ -42,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/clive/__private/ui/widgets/place_taker.py b/clive/__private/ui/widgets/place_taker.py index bcdb0e744592710b44b4fe875e355d73a4ee375a..19aee437ccd49a75cc37899324a11a5ed1170c96 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/clive/__private/ui/widgets/section.py b/clive/__private/ui/widgets/section.py index da4ee84b1e53f97a11093691e78d62fcbc9a5c5e..f0424573fba442f831930218682e5a660def793f 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 { @@ -25,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 { @@ -49,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/clive/__private/ui/widgets/select/safe_select.py b/clive/__private/ui/widgets/select/safe_select.py index 663ce7b1debe083d36a239f50a028999e1f9a7ef..2a437a6a8a7a050c5dd582d42a772f8ae4b0663c 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/clive/__private/ui/widgets/switch_working_account_container.py b/clive/__private/ui/widgets/switch_working_account_container.py index 597616b66bf8faf7531783d434065324c3436b43..e552182ebe9eb7e7e39b510b589a95e9a91d10c6 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: @@ -73,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/clive/__private/ui/widgets/titled_label.py b/clive/__private/ui/widgets/titled_label.py index 77abc04a3619a0e653e8d4db6d0888d408f668b2..153cd432ba917567b63df499c709ddcf934900b4 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 04df7ec77ae5804d8aaecdc7b2328fcb16039b3a..891d8ce2acdbe5b04007681edfb317e4638c8a58 100644 --- a/pydoclint-errors-baseline.txt +++ b/pydoclint-errors-baseline.txt @@ -405,342 +405,57 @@ 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]. - 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. 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.) - 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]. - 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 - 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.) - 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 -------------------- -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.) --------------------- -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.) - 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.) --------------------- -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.) --------------------- -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.) - 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.) - 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. - 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. - 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.) --------------------- 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]. 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. - 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.) - 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.) --------------------- -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. - 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 - 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 - 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]. - 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]. 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 -------------------- -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.) - 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]. -------------------- -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]. --------------------- 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]. - 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]. --------------------- 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. - 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]. 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. - 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. - 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]. --------------------- -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]. --------------------- -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]. --------------------- -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]]. --------------------- -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]. --------------------- -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.) 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. 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.) - 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.) --------------------- -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.) - 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. - 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]]. --------------------- 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. - 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 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].