@@ -591,6 +591,8 @@ 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`.
594596 """
595597 warnings .warn ("Server._list_panes() is deprecated" , stacklevel = 2 )
596598 return [p .__dict__ for p in self .panes ]
@@ -604,26 +606,46 @@ def _update_panes(self) -> "Server":
604606 :class:`Server`
605607
606608 .. deprecated:: 0.16
609+
610+ Deprecated in favor of :attr:`.panes` and returning ``self``.
607611 """
608612 warnings .warn ("Server._update_panes() is deprecated" , stacklevel = 2 )
609613 self ._list_panes ()
610614 return self
611615
612616 def get_by_id (self , id : str ) -> t .Optional [Session ]:
613- """.. deprecated:: 0.16."""
617+ """Return session by id. Deprecated in favor of :meth:`.sessions.get()`.
618+
619+ .. deprecated:: 0.16.
620+
621+ Deprecated by :meth:`.sessions.get()`.
622+
623+ """
614624 warnings .warn ("Server.get_by_id() is deprecated" , stacklevel = 2 )
615625 return self .sessions .get (session_id = id , default = None )
616626
617627 def where (self , kwargs : t .Dict [str , t .Any ]) -> t .List [Session ]:
618- """.. deprecated:: 0.16."""
628+ """Filter through sessions, return list of :class:`Session`.
629+
630+ .. deprecated:: 0.16
631+
632+ Deprecated by :meth:`.session.filter()`.
633+
634+ """
619635 warnings .warn ("Server.find_where() is deprecated" , stacklevel = 2 )
620636 try :
621637 return self .sessions .filter (** kwargs )
622638 except IndexError :
623639 return []
624640
625641 def find_where (self , kwargs : t .Dict [str , t .Any ]) -> t .Optional [Session ]:
626- """.. deprecated:: 0.16."""
642+ """Filter through sessions, return first :class:`Session`.
643+
644+ .. deprecated:: 0.16.
645+
646+ Slated to be removed in favor of :meth:`.sessions.get()`.
647+
648+ """
627649 warnings .warn ("Server.find_where() is deprecated" , stacklevel = 2 )
628650 return self .sessions .get (default = None , ** kwargs )
629651
@@ -636,6 +658,9 @@ def _list_windows(self) -> t.List[WindowDict]:
636658 :class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
637659
638660 .. deprecated:: 0.16
661+
662+ Slated to be removed in favor of :attr:`.windows`.
663+
639664 """
640665 warnings .warn ("Server._list_windows() is deprecated" , stacklevel = 2 )
641666 return [w .__dict__ for w in self .windows ]
@@ -644,6 +669,9 @@ def _update_windows(self) -> "Server":
644669 """Update internal window data and return ``self`` for chainability.
645670
646671 .. deprecated:: 0.16
672+
673+ Deprecated in favor of :attr:`.windows` and returning ``self``.
674+
647675 """
648676 warnings .warn ("Server._update_windows() is deprecated" , stacklevel = 2 )
649677 self ._list_windows ()
@@ -654,12 +682,20 @@ def _sessions(self) -> t.List[SessionDict]:
654682 """Property / alias to return :meth:`~._list_sessions`.
655683
656684 .. deprecated:: 0.16
685+
686+ Slated to be removed in favor of :attr:`.sessions`.
687+
657688 """
658689 warnings .warn ("Server._sessions is deprecated" , stacklevel = 2 )
659690 return self ._list_sessions ()
660691
661692 def _list_sessions (self ) -> t .List ["SessionDict" ]:
662- """.. deprecated:: 0.16."""
693+ """Return list of session object dictionaries.
694+
695+ .. deprecated:: 0.16
696+
697+ Slated to be removed in favor of :attr:`.sessions`.
698+ """
663699 warnings .warn ("Server._list_sessions() is deprecated" , stacklevel = 2 )
664700 return [s .__dict__ for s in self .sessions ]
665701
@@ -668,6 +704,8 @@ def list_sessions(self) -> t.List[Session]:
668704
669705 .. deprecated:: 0.16
670706
707+ Slated to be removed in favor of :attr:`.sessions`.
708+
671709 Returns
672710 -------
673711 list of :class:`Session`
@@ -680,6 +718,9 @@ def children(self) -> QueryList["Session"]: # type:ignore
680718 """Was used by TmuxRelationalObject (but that's longer used in this class).
681719
682720 .. deprecated:: 0.16
721+
722+ Slated to be removed in favor of :meth:`.sessions`.
723+
683724 """
684725 warnings .warn ("Server.children is deprecated" , stacklevel = 2 )
685726 return self .sessions
0 commit comments