Skip to content

Commit 56921d7

Browse files
committed
docs(common): Tighten and correct docstrings
1 parent 98496f0 commit 56921d7

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

src/libtmux/common.py

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ def __init__(self, add_option: Optional[str] = None) -> None:
4646
self._add_option = add_option
4747

4848
def set_environment(self, name: str, value: str) -> None:
49-
"""
50-
Set environment ``$ tmux set-environment <name> <value>``.
49+
"""Set environment ``$ tmux set-environment <name> <value>``.
5150
5251
Parameters
5352
----------
@@ -73,8 +72,7 @@ def set_environment(self, name: str, value: str) -> None:
7372
raise ValueError("tmux set-environment stderr: %s" % cmd.stderr)
7473

7574
def unset_environment(self, name: str) -> None:
76-
"""
77-
Unset environment variable ``$ tmux set-environment -u <name>``.
75+
"""Unset environment variable ``$ tmux set-environment -u <name>``.
7876
7977
Parameters
8078
----------
@@ -190,8 +188,7 @@ def getenv(self, name: str) -> Optional[t.Union[str, bool]]:
190188

191189

192190
class tmux_cmd:
193-
"""
194-
:term:`tmux(1)` command via :py:mod:`subprocess`.
191+
""":term:`tmux(1)` command via :py:mod:`subprocess`.
195192
196193
Examples
197194
--------
@@ -264,8 +261,7 @@ def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
264261

265262

266263
def get_version() -> LooseVersion:
267-
"""
268-
Return tmux version.
264+
"""Return tmux version.
269265
270266
If tmux is built from git master, the version returned will be the latest
271267
version appended with -master, e.g. ``2.4-master``.
@@ -301,8 +297,7 @@ def get_version() -> LooseVersion:
301297

302298

303299
def has_version(version: str) -> bool:
304-
"""
305-
Return affirmative if tmux version installed.
300+
"""Return True if tmux version installed.
306301
307302
Parameters
308303
----------
@@ -318,8 +313,7 @@ def has_version(version: str) -> bool:
318313

319314

320315
def has_gt_version(min_version: str) -> bool:
321-
"""
322-
Return affirmative if tmux version greater than minimum.
316+
"""Return True if tmux version greater than minimum.
323317
324318
Parameters
325319
----------
@@ -335,8 +329,7 @@ def has_gt_version(min_version: str) -> bool:
335329

336330

337331
def has_gte_version(min_version: str) -> bool:
338-
"""
339-
Return True if tmux version greater or equal to minimum.
332+
"""Return True if tmux version greater or equal to minimum.
340333
341334
Parameters
342335
----------
@@ -352,8 +345,7 @@ def has_gte_version(min_version: str) -> bool:
352345

353346

354347
def has_lte_version(max_version: str) -> bool:
355-
"""
356-
Return True if tmux version less or equal to minimum.
348+
"""Return True if tmux version less or equal to minimum.
357349
358350
Parameters
359351
----------
@@ -369,8 +361,7 @@ def has_lte_version(max_version: str) -> bool:
369361

370362

371363
def has_lt_version(max_version: str) -> bool:
372-
"""
373-
Return True if tmux version less than minimum.
364+
"""Return True if tmux version less than minimum.
374365
375366
Parameters
376367
----------
@@ -386,8 +377,7 @@ def has_lt_version(max_version: str) -> bool:
386377

387378

388379
def has_minimum_version(raises: bool = True) -> bool:
389-
"""
390-
Return if tmux meets version requirement. Version >1.8 or above.
380+
"""Return True if tmux meets version requirement. Version >1.8 or above.
391381
392382
Parameters
393383
----------

0 commit comments

Comments
 (0)