Skip to content

Commit 174bbfb

Browse files
style: convert all docstrings from reST to Markdown formatting
Co-Authored-By: AJ Steers <aj@airbyte.io>
1 parent f0b26d7 commit 174bbfb

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

airbyte/_util/destination_smoke_tests.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
NAMESPACE_PREFIX = "zz_deleteme"
3838
"""Prefix for auto-generated smoke test namespaces.
3939
40-
The ``zz_`` prefix sorts last alphabetically; ``deleteme`` signals the
40+
The `zz_` prefix sorts last alphabetically; `deleteme` signals the
4141
namespace is safe for automated cleanup.
4242
"""
4343

@@ -56,11 +56,11 @@ def generate_namespace(
5656
) -> str:
5757
"""Generate a smoke-test namespace.
5858
59-
Format: ``zz_deleteme_yyyymmdd_hhmm_<suffix>``.
60-
The ``zz_`` prefix sorts last alphabetically and the ``deleteme``
59+
Format: `zz_deleteme_yyyymmdd_hhmm_<suffix>`.
60+
The `zz_` prefix sorts last alphabetically and the `deleteme`
6161
token acts as a guard for automated cleanup scripts.
6262
63-
If *namespace_suffix* is not provided, ``smoke_test`` is used as the
63+
If `namespace_suffix` is not provided, `smoke_test` is used as the
6464
default suffix.
6565
"""
6666
suffix = namespace_suffix or DEFAULT_NAMESPACE_SUFFIX
@@ -77,7 +77,7 @@ def generate_namespace(
7777
class DestinationReadbackResult(BaseModel):
7878
"""Result of reading back destination-written data.
7979
80-
Uses ``TableStatistics`` from the SQL processor layer to provide
80+
Uses `TableStatistics` from the SQL processor layer to provide
8181
per-table row counts, column names/types, and per-column null/non-null
8282
counts.
8383
"""
@@ -319,7 +319,7 @@ def run_destination_smoke_test(
319319
introspection is automatically performed after a successful write.
320320
The readback produces stats on the written data (table row counts,
321321
column names/types, and per-column null/non-null counts) and is
322-
included in the result as ``readback_result``.
322+
included in the result as `readback_result`.
323323
324324
`destination` is a resolved `Destination` object ready for writing.
325325
@@ -330,8 +330,8 @@ def run_destination_smoke_test(
330330
- A comma-separated string or list of specific scenario names.
331331
332332
`namespace_suffix` is an optional suffix appended to the auto-generated
333-
namespace. Defaults to ``smoke_test`` when not provided
334-
(e.g. ``zz_deleteme_20260318_2256_smoke_test``).
333+
namespace. Defaults to `smoke_test` when not provided
334+
(e.g. `zz_deleteme_20260318_2256_smoke_test`).
335335
336336
`reuse_namespace` is an exact namespace string to reuse from a previous
337337
run. When set, no new namespace is generated.

airbyte/caches/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,11 +445,11 @@ def get_table_statistics(
445445
) -> dict[str, TableStatistics]:
446446
"""Return table statistics for the given stream names.
447447
448-
Delegates to ``self.processor.get_table_statistics()`` which queries
448+
Delegates to `self.processor.get_table_statistics()` which queries
449449
row counts, column info, and per-column null/non-null stats for each
450450
stream.
451451
452-
Returns a dict mapping stream name to a ``TableStatistics`` instance.
452+
Returns a dict mapping stream name to a `TableStatistics` instance.
453453
Streams whose tables are not found are omitted from the result.
454454
"""
455455
return self.processor.get_table_statistics(stream_names)

airbyte/destinations/base.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ def __init__(
6666

6767
@staticmethod
6868
def _normalize_destination_name(name: str) -> str:
69-
"""Normalize a destination name to canonical form (``destination-<type>``).
69+
"""Normalize a destination name to canonical form (`destination-<type>`).
7070
71-
Accepts either the short form (e.g. ``snowflake``) or the canonical
72-
form (e.g. ``destination-snowflake``).
71+
Accepts either the short form (e.g. `snowflake`) or the canonical
72+
form (e.g. `destination-snowflake`).
7373
"""
7474
if not name.startswith(_CANONICAL_PREFIX):
7575
return f"{_CANONICAL_PREFIX}{name}"

airbyte/shared/sql_processor.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1219,7 +1219,7 @@ def get_row_count(
12191219
) -> int:
12201220
"""Return the number of rows in the given table.
12211221
1222-
Raises ``SQLRuntimeError`` if the table does not exist or the query
1222+
Raises `SQLRuntimeError` if the table does not exist or the query
12231223
fails for any other reason.
12241224
"""
12251225
sql = f"SELECT COUNT(*) AS row_count FROM {self._fully_qualified(table_name)}"
@@ -1237,7 +1237,7 @@ def get_column_info(
12371237
) -> list[dict[str, str]]:
12381238
"""Return column names and types for the given table.
12391239
1240-
Each entry is a dict with ``column_name`` and ``column_type`` keys.
1240+
Each entry is a dict with `column_name` and `column_type` keys.
12411241
12421242
Raises if the table does not exist or is not accessible.
12431243
"""
@@ -1259,13 +1259,13 @@ def get_column_stats(
12591259
) -> list[dict[str, Any]]:
12601260
"""Return per-column null/non-null counts for the given table.
12611261
1262-
*columns* should be a list of dicts with at least a ``column_name``
1263-
key (as returned by :meth:`get_column_info`).
1262+
`columns` should be a list of dicts with at least a `column_name`
1263+
key (as returned by `get_column_info()`).
12641264
1265-
Returns a list of dicts with ``column_name``, ``null_count``,
1266-
``non_null_count``, and ``total_count`` keys.
1265+
Returns a list of dicts with `column_name`, `null_count`,
1266+
`non_null_count`, and `total_count` keys.
12671267
1268-
Positional aliases (``nn_0``, ``nn_1``, ...) are used instead of
1268+
Positional aliases (`nn_0`, `nn_1`, ...) are used instead of
12691269
column-name-derived aliases to avoid issues with databases that
12701270
truncate long identifiers (PostgreSQL: 63 chars).
12711271
"""
@@ -1323,7 +1323,7 @@ def get_table_statistics(
13231323
If the normalized table name is not found, falls back to the original
13241324
stream name (some destinations preserve original casing).
13251325
1326-
Returns a dict mapping stream name to a ``TableStatistics`` instance.
1326+
Returns a dict mapping stream name to a `TableStatistics` instance.
13271327
Streams whose tables are not found are omitted from the result.
13281328
"""
13291329
result: dict[str, TableStatistics] = {}

0 commit comments

Comments
 (0)