Skip to content

Commit ef388a0

Browse files
igerberclaude
andcommitted
Document max_iter and tol parameters in within_transform docstring
Both parameters apply only when weights is not None. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 4a7fee3 commit ef388a0

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

diff_diff/utils.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1843,6 +1843,14 @@ def within_transform(
18431843
Suffix for new column names when inplace=False.
18441844
weights : np.ndarray, optional
18451845
Observation weights for weighted group means.
1846+
max_iter : int, default 100
1847+
Maximum number of alternating-projection iterations. Used only when
1848+
``weights`` is not ``None``; the unweighted path is a single pass and
1849+
ignores this argument. Emits a ``UserWarning`` per call when any
1850+
variable fails to converge within this budget.
1851+
tol : float, default 1e-8
1852+
Convergence tolerance on the max absolute change across the iterate.
1853+
Used only when ``weights`` is not ``None``.
18461854
18471855
Returns
18481856
-------

0 commit comments

Comments
 (0)