mcp(docs[_utils]): Document CallerIdentity fields - #105
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #105 +/- ##
=======================================
Coverage 86.13% 86.13%
=======================================
Files 46 46
Lines 3593 3593
Branches 516 516
=======================================
Hits 3095 3095
Misses 354 354
Partials 144 144 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tony
force-pushed
the
attributes-backfill
branch
from
July 26, 2026 00:57
40886f4 to
b34679e
Compare
why: Undocumented dataclass fields render in the API reference as "Alias for field number 0" or bare names, leaving readers to infer what each part of the parsed $TMUX/$TMUX_PANE identity means and what its None sentinel implies for the socket comparisons. what: - Add a NumPy Attributes section to CallerIdentity covering the socket path, server pid, session id, and pane id - Record which environment variable field each value comes from and what an unset value means for caller-on-server checks
why: The unreleased entry did not record that class fields now carry descriptions where the API reference renders them. what: - Note the described fields under Documentation
tony
force-pushed
the
attributes-backfill
branch
from
July 26, 2026 01:22
6809941 to
e862fb5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CallerIdentitycarried a class docstring but no per-field descriptions, so autodoc rendered its fields bare in the API reference (a NamedTuple in the same position renders as "Alias for field number 0"), leaving readers to guess which$TMUX/$TMUX_PANEcomponent each field holds and what itsNonesentinel means for the caller-on-server checks. This adds a NumPyAttributessection naming the source environment variable field and the meaning of an unset value for each. Docstrings only — no code, signature, or field-order changes.Gates run and passing:
just ruff-format,just ruff,uv run mypy .,just test,just build-docs.The docs build now emits duplicate-object warnings for the four documented fields (
duplicate object description of libtmux_mcp._utils.CallerIdentity.<field>, other instance in reference/api/utils). The NumPy preprocessor emits an.. attribute::for each entry while autodoc also renders the field, so both register the same object. The build still succeeds. Left unsuppressed here deliberately — the fix belongs in gp-sphinx and is being handled there rather than by adding asuppress_warningsentry todocs/conf.py.Closes #104