Skip to content

Commit a2c2b60

Browse files
committed
doc updates
1 parent e27425e commit a2c2b60

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

doc/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,5 @@ Exceptions
126126
.. autoexception:: tmuxp.exc.EmptyConfigException
127127

128128
.. autoexception:: tmuxp.exc.ConfigError
129+
130+

tmuxp/config.py

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -198,12 +198,14 @@ def trickle(config):
198198

199199

200200
def import_tmuxinator(sconf):
201-
'''
201+
'''Import yaml configs from `tmuxinator`_.
202+
203+
.. _tmuxinator: https://github.com/aziz/tmuxinator
204+
205+
:todo: handle 'root' with a cd shell_command_before
206+
202207
:param sconf: python dict for session configuration
203208
:type sconf: dict
204-
205-
# https://github.com/aziz/tmuxinator
206-
# TODO: handle 'root' with a cd shell_command_before
207209
'''
208210

209211
tmuxp_config = {}
@@ -285,17 +287,18 @@ def import_tmuxinator(sconf):
285287

286288

287289
def import_teamocil(sconf):
288-
'''
289-
:param sconf: python dict for session configuration
290-
:type sconf: dict
290+
'''Import yaml configs from `teamocil`_.
291+
292+
.. _teamocil: https://github.com/remiprev/teamocil
291293
292-
# https://github.com/remiprev/teamocil
294+
:todo: change 'root' to a cd or start_directory
295+
:todo: width in pane -> main-pain-width
296+
:todo: with_env_var
297+
:todo: clear
298+
:todo: cmd_separator
293299
294-
# todo, change 'root' to a cd or start_directory
295-
# todo: width in pane -> main-pain-width
296-
# todo: with_env_var
297-
# todo: clear
298-
# todo: cmd_separator
300+
:param sconf: python dict for session configuration
301+
:type sconf: dict
299302
'''
300303

301304
tmuxp_config = {}

0 commit comments

Comments
 (0)