Skip to content

Commit eaec3e7

Browse files
committed
docs(docstrings): Fix RST formatting in find_workspace_file docstring
Add missing Returns and Raises sections to complete the NumPy-style docstring and fix RST field list parsing error.
1 parent fc8fff8 commit eaec3e7

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/tmuxp/workspace/finders.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,21 @@ def find_workspace_file(
153153
Parameters
154154
----------
155155
workspace_file : str
156-
workspace file, valid examples:
156+
Workspace file, valid examples:
157157
158158
- a file name, my_workspace.yaml
159159
- relative path, ../my_workspace.yaml or ../project
160160
- a period, .
161+
162+
Returns
163+
-------
164+
str
165+
Resolved absolute path to workspace file.
166+
167+
Raises
168+
------
169+
FileNotFoundError
170+
If workspace file cannot be found.
161171
"""
162172
if not workspace_dir:
163173
workspace_dir = get_workspace_dir()

0 commit comments

Comments
 (0)