Skip to content

Commit ddeb5f3

Browse files
committed
chore(neo): pydocstyle manual fixes
1 parent 023aa2f commit ddeb5f3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/libtmux/neo.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""Tools for hydrating tmux data into python dataclass objects."""
12
import dataclasses
23
import logging
34
import typing as t
@@ -31,6 +32,8 @@
3132

3233
@dataclasses.dataclass()
3334
class Obj:
35+
"""Dataclass of generic tmux object."""
36+
3437
server: "Server"
3538

3639
active_window_index: t.Union[str, None] = None
@@ -180,6 +183,7 @@ def fetch_objs(
180183
list_cmd: "ListCmd",
181184
list_extra_args: "t.Optional[ListExtraArgs]" = None,
182185
) -> OutputsRaw:
186+
"""Fetch a listing of raw data from a tmux command."""
183187
formats = list(Obj.__dataclass_fields__.keys())
184188

185189
cmd_args: t.List[t.Union[str, int]] = []
@@ -227,6 +231,7 @@ def fetch_obj(
227231
list_cmd: "ListCmd" = "list-panes",
228232
list_extra_args: "t.Optional[ListExtraArgs]" = None,
229233
) -> OutputRaw:
234+
"""Fetch raw data from tmux command."""
230235
obj_formatters_filtered = fetch_objs(
231236
server=server, list_cmd=list_cmd, list_extra_args=list_extra_args
232237
)

0 commit comments

Comments
 (0)