Skip to content

Commit 2a99c3c

Browse files
committed
update quickstart docs
1 parent 7c48514 commit 2a99c3c

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

doc/quickstart.rst

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ find our current session with:
9191
9292
However, this isn't guaranteed, libtmux works against current tmux information, the
9393
session's name could be changed, or another tmux session may be created,
94-
so :meth:`Server.get_by_id` and :meth:`Server.findWhere` exists as a lookup.
94+
so :meth:`Server.get_by_id` and :meth:`Server.find_where` exists as a lookup.
9595

9696
Get session by ID
9797
-----------------
@@ -111,25 +111,21 @@ You may ``session = server.get_by_id('$<yourId>')`` to use the session object.
111111
Get session by name / other properties
112112
--------------------------------------
113113

114-
I really like `Backbone`_'s approach to handling collections of structured
115-
data. So I made a :meth:`Server.findWhere` method modelled after
116-
`Backbone.Collection.prototype.findWhere`_.
117-
118114
.. code-block:: python
119115
120-
>>> server.findWhere({ "session_name": "foo" })
116+
>>> server.find_where({ "session_name": "foo" })
121117
Session($3 foo)
122118
123-
With ``findWhere``, pass in a dict and return the first object found. In
119+
With ``find_where``, pass in a dict and return the first object found. In
124120
this case, a :class:`Server` holds a collection of child :class:`Session`.
125-
:class:`Session` and :class:`Window` both utilize ``findWhere`` to sift
121+
:class:`Session` and :class:`Window` both utilize ``find_where`` to sift
126122
through Windows and Panes, respectively.
127123

128124
So you may now use:
129125

130126
.. code-block:: python
131127
132-
>>> session = server.findWhere({ "session_name": "foo" })
128+
>>> session = server.find_where({ "session_name": "foo" })
133129
134130
to give us a ``session`` object to play with.
135131

@@ -203,7 +199,7 @@ And kill:
203199
204200
>>> window.kill_window()
205201
206-
Use :meth:`Session.list_windows()` and :meth:`Session.findWhere()` to list and sort
202+
Use :meth:`Session.list_windows()` and :meth:`Session.find_where()` to list and sort
207203
through active :class:`Window`'s.
208204

209205
Manipulating windows
@@ -302,8 +298,6 @@ sessions in the background. :)
302298
and our `test suite`_ (see :ref:`developing`.)
303299

304300
.. _sliderepl: http://discorporate.us/projects/sliderepl/
305-
.. _backbone: http:/ /backbonejs.org
306-
.. _Backbone.Collection.prototype.findWhere: http://backbonejs.org/#Collection-findWhere
307301
.. _workspacebuilder.py: https://github.com/tony/libtmux/blob/master/libtmux/workspacebuilder.py
308302
.. _test suite: https://github.com/tony/libtmux/tree/master/tests
309303
.. _ptpython: https://github.com/jonathanslenders/ptpython

0 commit comments

Comments
 (0)