Skip to content

Commit 0f44024

Browse files
committed
docs(CHANGES): Note Sphinx warning fixes
1 parent 990155e commit 0f44024

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

CHANGES

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,21 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
3131

3232
<!-- To maintainers and contributors: Please add notes for the forthcoming version below -->
3333

34-
_Future release notes will be placed here_
34+
_Upcoming changes will be written here._
35+
36+
### Documentation (#997)
37+
38+
Sphinx build warnings fixed:
39+
40+
- `docs/conf.py`: Add sphinx-autodoc-typehints configuration
41+
(`always_document_param_types`, `typehints_use_rtype`) and suppress
42+
forward reference warnings from TYPE_CHECKING blocks
43+
- `src/tmuxp/workspace/builder.py`: Fix "via via" typo in docstring
44+
- `src/tmuxp/workspace/freezer.py`: Fix "workspacee" typo in docstring
45+
- `src/tmuxp/log.py`: Fix RST parameter formatting in docstrings
46+
- `src/tmuxp/workspace/finders.py`: Add missing Returns/Raises sections
47+
to `find_workspace_file` docstring
48+
- `docs/about_tmux.md`: Fix orphan footnote reference
3549

3650
## tmuxp 1.59.0 (2025-11-30)
3751

0 commit comments

Comments
 (0)