Skip to content

Commit 6af2009

Browse files
committed
docs: Add bidirectional cross-references between sync and async pane methods
Complete bidirectional documentation linking by adding "See Also" sections to sync methods pointing to their async counterparts. Changes to src/libtmux/pane.py: 1. Pane.send_keys() → links to asend_keys() - Added "See Also" section after parameters, before examples 2. Pane.capture_pane() → links to acapture_pane() - Added "See Also" section after parameters 3. Pane.split() → links to asplit() - Added "See Also" section after parameters, before examples This completes the bidirectional documentation linking pattern: - Async methods already link to sync versions (added in previous commits) - Sync methods now link to async versions (this commit) Users can now easily discover async alternatives when reading sync documentation and vice versa, providing seamless navigation between the two API styles. Related: Phase 1 async expansion - documentation improvements
1 parent 73e7a42 commit 6af2009

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/libtmux/pane.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -838,6 +838,10 @@ def capture_pane(
838838
Negative numbers are lines in the history.
839839
`-` is the end of the visible pane
840840
Default: None
841+
842+
See Also
843+
--------
844+
:meth:`acapture_pane` : Async version of this method
841845
"""
842846
cmd = ["capture-pane", "-p"]
843847
if start is not None:
@@ -873,6 +877,10 @@ def send_keys(
873877
literal : bool, optional
874878
Send keys literally, default False.
875879
880+
See Also
881+
--------
882+
:meth:`asend_keys` : Async version of this method
883+
876884
Examples
877885
--------
878886
>>> pane = window.split(shell='sh')
@@ -1090,6 +1098,10 @@ def split(
10901098
environment: dict, optional
10911099
Environmental variables for new pane. tmux 3.0+ only. Passthrough to ``-e``.
10921100
1101+
See Also
1102+
--------
1103+
:meth:`asplit` : Async version of this method
1104+
10931105
Examples
10941106
--------
10951107
>>> (pane.at_left, pane.at_right,

0 commit comments

Comments
 (0)