Skip to content

Commit 21cc188

Browse files
authored
docs(shared): drop __future__ module references from project_resolver docstrings (#68)
The __future__ domain object (LogStream, Experiment, ...) references were stale placeholders; simplify the docstrings to describe the resolver in terms of the modules that exist today.
1 parent c768d7c commit 21cc188

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

src/splunk_ao/shared/project_resolver.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
"""Shared helper for resolving a project from explicit params or env fallbacks.
22
3-
Lives alongside :func:`splunk_ao.shared.exceptions._project_not_found_error` so the
4-
two helpers"how to find a project" and "what error to raise when you can't" —
5-
sit in one place and can be reused by every ``__future__`` domain object
6-
(LogStream, Experiment, …) instead of being duplicated per-class.
3+
This lives alongside :func:`splunk_ao.shared.exceptions._project_not_found_error`
4+
so the two concerns — how to find a project, and what error to raise when one
5+
can't be found — stay together in one place and can be reused across modules
6+
instead of being duplicated in each one.
77
"""
88

99
from __future__ import annotations

tests/shared/test_project_resolver.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
"""Unit tests for ``splunk_ao.shared.project_resolver._resolve_project``.
22
3-
The resolver is the single canonical entry point used by every ``__future__``
4-
domain object (LogStream, Experiment, …) to turn explicit kwargs / env vars
5-
into a concrete project. These tests pin its contract so future callers
6-
behave consistently.
3+
This resolver is the single canonical entry point every module should use to
4+
turn explicit kwargs or env vars into a concrete project. These tests pin
5+
down its contract so future callers behave consistently.
76
"""
87

98
from unittest.mock import MagicMock, patch

0 commit comments

Comments
 (0)