From 30254374dcfe4d0130a1164d665023a7f637d836 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9on=20Avic=20Simmons?= Date: Sat, 27 Jun 2026 15:29:37 -0400 Subject: [PATCH] docs: fix typos in docstrings and comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - devices.py: fix "addresss" → "addresses", "adress" → "address" (2x), "ip address" → "ip addresses" (plural), "values" → "value" (docstring parameter name mismatch) - add_adapter_cnxs_from_csv.py: fix "execption" → "exception" - paging_state.py: fix copy-paste module docstring — said "API for working with adapters" but module handles paging state --- axonius_api_client/api/assets/devices.py | 10 +++++----- axonius_api_client/api/json_api/paging_state.py | 2 +- .../examples/add_adapter_cnxs_from_csv.py | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/axonius_api_client/api/assets/devices.py b/axonius_api_client/api/assets/devices.py index 190c4606..68f96964 100644 --- a/axonius_api_client/api/assets/devices.py +++ b/axonius_api_client/api/assets/devices.py @@ -85,7 +85,7 @@ def get_by_macs(self, values: List[str], **kwargs) -> GEN_TYPE: # pragma: no co """Build a query to get assets where :attr:`FIELD_MAC` in values. Args: - values: list of mac addresss + values: list of mac addresses **kwargs: passed to :meth:`get_by_values` """ kwargs["field"] = self.FIELD_MAC @@ -97,7 +97,7 @@ def get_by_mac_regex(self, value: str, **kwargs) -> GEN_TYPE: # pragma: no cove """Build a query to get assets where :attr:`FIELD_MAC` regex matches value. Args: - value: regex of mac adress to match + value: regex of mac address to match **kwargs: passed to :meth:`get_by_value_regex` """ kwargs["field"] = self.FIELD_MAC @@ -109,7 +109,7 @@ def get_by_mac(self, value: str, **kwargs) -> GEN_TYPE: # pragma: no cover """Build a query to get assets where :attr:`FIELD_MAC` == value. Args: - value: mac adress + value: mac address **kwargs: passed to :meth:`get_by_value` """ kwargs["field"] = self.FIELD_MAC @@ -121,7 +121,7 @@ def get_by_ips(self, values: List[str], **kwargs) -> GEN_TYPE: # pragma: no cov """Build a query to get assets where :attr:`FIELD_IP` in values. Args: - values: list of ip address + values: list of ip addresses **kwargs: passed to :meth:`get_by_values` """ kwargs["field"] = self.FIELD_IP @@ -133,7 +133,7 @@ def get_by_ip_regex(self, value: str, **kwargs) -> GEN_TYPE: # pragma: no cover """Build a query to get assets where :attr:`FIELD_IP` regex matches value. Args: - values: regex of ip address to match + value: regex of ip address to match **kwargs: passed to :meth:`get_by_value_regex` """ kwargs["field"] = self.FIELD_IP diff --git a/axonius_api_client/api/json_api/paging_state.py b/axonius_api_client/api/json_api/paging_state.py index 1cd86ed2..8c44819a 100644 --- a/axonius_api_client/api/json_api/paging_state.py +++ b/axonius_api_client/api/json_api/paging_state.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -"""API for working with adapters.""" +"""API for working with paging state.""" import dataclasses import datetime import logging diff --git a/axonius_api_client/examples/add_adapter_cnxs_from_csv.py b/axonius_api_client/examples/add_adapter_cnxs_from_csv.py index bfb2922e..e346ac85 100644 --- a/axonius_api_client/examples/add_adapter_cnxs_from_csv.py +++ b/axonius_api_client/examples/add_adapter_cnxs_from_csv.py @@ -100,7 +100,7 @@ def check_schema(schema: dict, configs: List, ignore_unknown_keys: bool = False) for i, key in enumerate(configs): if key not in schema_keys: - # add an execption here for special supported keys + # add an exception here for special supported keys if key.startswith('*'): continue # process the rest like normal