@@ -591,6 +591,9 @@ def _list_panes(self) -> t.List[PaneDict]:
591591 :class:`util.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
592592
593593 .. deprecated:: 0.16
594+
595+ Deprecated in favor of :attr:`.panes`.
596+
594597 """
595598 warnings .warn ("Server._list_panes() is deprecated" , stacklevel = 2 )
596599 return [p .__dict__ for p in self .panes ]
@@ -604,26 +607,47 @@ def _update_panes(self) -> "Server":
604607 :class:`Server`
605608
606609 .. deprecated:: 0.16
610+
611+ Deprecated in favor of :attr:`.panes` and returning ``self``.
612+
607613 """
608614 warnings .warn ("Server._update_panes() is deprecated" , stacklevel = 2 )
609615 self ._list_panes ()
610616 return self
611617
612618 def get_by_id (self , id : str ) -> t .Optional [Session ]:
613- """.. deprecated:: 0.16."""
619+ """Return session by id. Deprecated in favor of :meth:`.sessions.get()`.
620+
621+ .. deprecated:: 0.16.
622+
623+ Deprecated by :meth:`.sessions.get()`.
624+
625+ """
614626 warnings .warn ("Server.get_by_id() is deprecated" , stacklevel = 2 )
615627 return self .sessions .get (session_id = id , default = None )
616628
617629 def where (self , kwargs : t .Dict [str , t .Any ]) -> t .List [Session ]:
618- """.. deprecated:: 0.16."""
630+ """Filter through sessions, return list of :class:`Session`.
631+
632+ .. deprecated:: 0.16
633+
634+ Deprecated by :meth:`.session.filter()`.
635+
636+ """
619637 warnings .warn ("Server.find_where() is deprecated" , stacklevel = 2 )
620638 try :
621639 return self .sessions .filter (** kwargs )
622640 except IndexError :
623641 return []
624642
625643 def find_where (self , kwargs : t .Dict [str , t .Any ]) -> t .Optional [Session ]:
626- """.. deprecated:: 0.16."""
644+ """Filter through sessions, return first :class:`Session`.
645+
646+ .. deprecated:: 0.16.
647+
648+ Slated to be removed in favor of :meth:`.sessions.get()`.
649+
650+ """
627651 warnings .warn ("Server.find_where() is deprecated" , stacklevel = 2 )
628652 return self .sessions .get (default = None , ** kwargs )
629653
@@ -636,6 +660,9 @@ def _list_windows(self) -> t.List[WindowDict]:
636660 :class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
637661
638662 .. deprecated:: 0.16
663+
664+ Slated to be removed in favor of :attr:`.windows`.
665+
639666 """
640667 warnings .warn ("Server._list_windows() is deprecated" , stacklevel = 2 )
641668 return [w .__dict__ for w in self .windows ]
@@ -644,6 +671,9 @@ def _update_windows(self) -> "Server":
644671 """Update internal window data and return ``self`` for chainability.
645672
646673 .. deprecated:: 0.16
674+
675+ Deprecated in favor of :attr:`.windows` and returning ``self``.
676+
647677 """
648678 warnings .warn ("Server._update_windows() is deprecated" , stacklevel = 2 )
649679 self ._list_windows ()
@@ -654,12 +684,20 @@ def _sessions(self) -> t.List[SessionDict]:
654684 """Property / alias to return :meth:`~._list_sessions`.
655685
656686 .. deprecated:: 0.16
687+
688+ Slated to be removed in favor of :attr:`.sessions`.
689+
657690 """
658691 warnings .warn ("Server._sessions is deprecated" , stacklevel = 2 )
659692 return self ._list_sessions ()
660693
661694 def _list_sessions (self ) -> t .List ["SessionDict" ]:
662- """.. deprecated:: 0.16."""
695+ """Return list of session object dictionaries.
696+
697+ .. deprecated:: 0.16
698+
699+ Slated to be removed in favor of :attr:`.sessions`.
700+ """
663701 warnings .warn ("Server._list_sessions() is deprecated" , stacklevel = 2 )
664702 return [s .__dict__ for s in self .sessions ]
665703
@@ -668,6 +706,8 @@ def list_sessions(self) -> t.List[Session]:
668706
669707 .. deprecated:: 0.16
670708
709+ Slated to be removed in favor of :attr:`.sessions`.
710+
671711 Returns
672712 -------
673713 list of :class:`Session`
@@ -680,6 +720,9 @@ def children(self) -> QueryList["Session"]: # type:ignore
680720 """Was used by TmuxRelationalObject (but that's longer used in this class).
681721
682722 .. deprecated:: 0.16
723+
724+ Slated to be removed in favor of :meth:`.sessions`.
725+
683726 """
684727 warnings .warn ("Server.children is deprecated" , stacklevel = 2 )
685728 return self .sessions
0 commit comments