Skip to content

Commit 13c42cc

Browse files
committed
style: fix some mispelling and style issue in docstrings
1 parent e5cc8b7 commit 13c42cc

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

infrahub_sdk/client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ async def _process_nodes_and_relationships(
549549
schema_kind (str): The kind of schema being queried.
550550
branch (str): The branch name.
551551
prefetch_relationships (bool): Flag to indicate whether to prefetch relationship data.
552-
timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
552+
timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
553553
554554
Returns:
555555
ProcessRelationsNodeSync: A TypedDict containing two lists:
@@ -666,7 +666,7 @@ async def all(
666666
at (Timestamp, optional): Time of the query. Defaults to Now.
667667
branch (str, optional): Name of the branch to query from. Defaults to default_branch.
668668
populate_store (bool, optional): Flag to indicate whether to populate the store with the retrieved nodes.
669-
timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
669+
timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
670670
offset (int, optional): The offset for pagination.
671671
limit (int, optional): The limit for pagination.
672672
include (list[str], optional): List of attributes or relationships to include in the query.
@@ -763,7 +763,7 @@ async def filters(
763763
kind (str): kind of the nodes to query
764764
at (Timestamp, optional): Time of the query. Defaults to Now.
765765
branch (str, optional): Name of the branch to query from. Defaults to default_branch.
766-
timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
766+
timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
767767
populate_store (bool, optional): Flag to indicate whether to populate the store with the retrieved nodes.
768768
offset (int, optional): The offset for pagination.
769769
limit (int, optional): The limit for pagination.
@@ -1794,7 +1794,7 @@ def all(
17941794
kind (str): kind of the nodes to query
17951795
at (Timestamp, optional): Time of the query. Defaults to Now.
17961796
branch (str, optional): Name of the branch to query from. Defaults to default_branch.
1797-
timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
1797+
timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
17981798
populate_store (bool, optional): Flag to indicate whether to populate the store with the retrieved nodes.
17991799
offset (int, optional): The offset for pagination.
18001800
limit (int, optional): The limit for pagination.
@@ -1840,7 +1840,7 @@ def _process_nodes_and_relationships(
18401840
schema_kind (str): The kind of schema being queried.
18411841
branch (str): The branch name.
18421842
prefetch_relationships (bool): Flag to indicate whether to prefetch relationship data.
1843-
timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
1843+
timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
18441844
18451845
Returns:
18461846
ProcessRelationsNodeSync: A TypedDict containing two lists:
@@ -1927,7 +1927,7 @@ def filters(
19271927
kind (str): kind of the nodes to query
19281928
at (Timestamp, optional): Time of the query. Defaults to Now.
19291929
branch (str, optional): Name of the branch to query from. Defaults to default_branch.
1930-
timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
1930+
timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
19311931
populate_store (bool, optional): Flag to indicate whether to populate the store with the retrieved nodes.
19321932
offset (int, optional): The offset for pagination.
19331933
limit (int, optional): The limit for pagination.

infrahub_sdk/ctl/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def init_logging(debug: bool = False) -> None:
5151

5252

5353
def handle_exception(exc: Exception, console: Console, exit_code: int) -> NoReturn:
54-
"""Handle exeception in a different fashion based on its type."""
54+
"""Handle exception in a different fashion based on its type."""
5555
if isinstance(exc, Exit):
5656
raise typer.Exit(code=exc.exit_code)
5757
if isinstance(exc, AuthenticationError):

infrahub_sdk/jinja2.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
def identify_faulty_jinja_code(traceback: Traceback, nbr_context_lines: int = 3) -> list[tuple[Frame, Syntax]]:
88
"""This function identifies the faulty Jinja2 code and beautify it to provide meaningful information to the user.
99
10-
We use the rich's Traceback to parse the complete stack trace and extract Frames for each expection found in the trace.
10+
We use the rich's Traceback to parse the complete stack trace and extract Frames for each exception found in the trace.
1111
"""
1212
response = []
1313

infrahub_sdk/node/node.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ def generate_query_data_init(
419419
return data
420420

421421
def extract(self, params: dict[str, str]) -> dict[str, Any]:
422-
"""Extract some datapoints defined in a flat notation."""
422+
"""Extract some data points defined in a flat notation."""
423423
result: dict[str, Any] = {}
424424
for key, value in params.items():
425425
result[key] = get_flat_value(self, key=value)

infrahub_sdk/pytest_plugin/items/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def reportinfo(self) -> tuple[Path | str, int | None, str]:
7575
def repository_base(self) -> str:
7676
"""Return the path to the root of the repository
7777
78-
This will be an absolute path if --infrahub-config-path is an absolut path as happens when
78+
This will be an absolute path if --infrahub-config-path is an absolute path as happens when
7979
tests are started from within Infrahub server.
8080
"""
8181
config_path: Path = getattr(self.session, _infrahub_config_path_attribute)

0 commit comments

Comments
 (0)