Skip to content

Commit 5d01f58

Browse files
committed
docs(session): Fill in more documentation
1 parent bf600b3 commit 5d01f58

File tree

1 file changed

+53
-6
lines changed

1 file changed

+53
-6
lines changed

src/libtmux/session.py

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -594,37 +594,75 @@ def name(self) -> t.Optional[str]:
594594
# Legacy: Redundant stuff we want to remove
595595
#
596596
def get(self, key: str, default: t.Optional[t.Any] = None) -> t.Any:
597-
""".. deprecated:: 0.16."""
597+
"""Return key-based lookup. Deprecated by attributes.
598+
599+
.. deprecated:: 0.16.
600+
601+
Deprecated by attribute lookup.e.g. ``session['session_name']`` is now
602+
accessed via ``session.session_name``.
603+
604+
"""
598605
warnings.warn("Session.get() is deprecated", stacklevel=2)
599606
return getattr(self, key, default)
600607

601608
def __getitem__(self, key: str) -> t.Any:
602-
""".. deprecated:: 0.16."""
609+
"""Return item lookup by key. Deprecated in favor of attributes.
610+
611+
.. deprecated:: 0.16
612+
613+
Deprecated in favor of attributes. e.g. ``session['session_name']`` is now
614+
accessed via ``session.session_name``.
615+
616+
"""
603617
warnings.warn(
604618
f"Item lookups, e.g. session['{key}'] is deprecated", stacklevel=2
605619
)
606620
return getattr(self, key)
607621

608622
def get_by_id(self, id: str) -> t.Optional[Window]:
609-
""".. deprecated:: 0.16."""
623+
"""Return window by id. Deprecated in favor of :meth:`.windows.get()`.
624+
625+
.. deprecated:: 0.16.
626+
627+
Deprecated by :meth:`.windows.get()`.
628+
629+
"""
610630
warnings.warn("Session.get_by_id() is deprecated", stacklevel=2)
611631
return self.windows.get(window_id=id, default=None)
612632

613633
def where(self, kwargs: t.Dict[str, t.Any]) -> t.List[Window]:
614-
""".. deprecated:: 0.16."""
634+
"""Filter through window, return list of :class:`Window`.
635+
636+
.. deprecated:: 0.16
637+
638+
Deprecated by :meth:`.windows.filter()`.
639+
640+
"""
615641
warnings.warn("Session.where() is deprecated", stacklevel=2)
616642
try:
617643
return self.windows.filter(**kwargs)
618644
except IndexError:
619645
return []
620646

621647
def find_where(self, kwargs: t.Dict[str, t.Any]) -> t.Optional[Window]:
622-
""".. deprecated:: 0.16."""
648+
"""Filter through windows, return first :class:`Window`.
649+
650+
.. deprecated:: 0.16.
651+
652+
Slated to be removed in favor of :meth:`.windows.get()`.
653+
654+
"""
623655
warnings.warn("Session.find_where() is deprecated", stacklevel=2)
624656
return self.windows.get(default=None, **kwargs)
625657

626658
def _list_windows(self) -> t.List["WindowDict"]:
627-
""".. deprecated:: 0.16."""
659+
"""Return list of windows (deprecated in favor of :meth:`.windows`).
660+
661+
.. deprecated:: 0.16.
662+
663+
Slated to be removed in favor of :meth:`.windows`.
664+
665+
"""
628666
warnings.warn("Session._list_windows() is deprecated", stacklevel=2)
629667
return [w.__dict__ for w in self.windows]
630668

@@ -633,6 +671,9 @@ def _windows(self) -> t.List["WindowDict"]:
633671
"""Property / alias to return :meth:`Session._list_windows`.
634672
635673
.. deprecated:: 0.16
674+
675+
Slated to be removed in favor of :meth:`.windows`.
676+
636677
"""
637678
warnings.warn("Session._windows is deprecated", stacklevel=2)
638679
return self._list_windows()
@@ -641,6 +682,9 @@ def list_windows(self) -> t.List["Window"]:
641682
"""Return a list of :class:`Window` from the ``tmux(1)`` session.
642683
643684
.. deprecated:: 0.16
685+
686+
Slated to be removed in favor of :meth:`.windows`.
687+
644688
"""
645689
warnings.warn("Session.list_windows() is deprecated", stacklevel=2)
646690
return self.windows
@@ -650,6 +694,9 @@ def children(self) -> QueryList["Window"]: # type:ignore
650694
"""Was used by TmuxRelationalObject (but that's longer used in this class).
651695
652696
.. deprecated:: 0.16
697+
698+
Slated to be removed in favor of :meth:`.windows`.
699+
653700
"""
654701
warnings.warn("Session.children is deprecated", stacklevel=2)
655702
return self.windows

0 commit comments

Comments
 (0)