Skip to content

docs: fix all remaining docstring RST formatting for Sphinx/docutils compliance#154

Merged
SmithSamuelM merged 1 commit into
ioflo:mainfrom
jaelliot:fix/hio-docstring-wave2
Mar 18, 2026
Merged

docs: fix all remaining docstring RST formatting for Sphinx/docutils compliance#154
SmithSamuelM merged 1 commit into
ioflo:mainfrom
jaelliot:fix/hio-docstring-wave2

Conversation

@jaelliot
Copy link
Copy Markdown
Contributor

Summary

Completes the docstring RST cleanup started in wave-1 PRs (#137-#147). After this PR, make -C docs html builds with 0 warnings and 0 errors (clean from 303+ errors on upstream main).

Changes

Python source docstrings (30 files)

  • Fix unexpected-indentation errors by converting free-form text blocks to proper RST list items and explicit literal blocks
  • Fix inline markup issues (unclosed *, malformed ``)
  • Minor typo fixes (converstionconversion, accomodateaccommodate)

Sphinx configuration (docs/source/conf.py)

  • Expand autoapi_dirs from base/ only to the full hio package (all modules now covered)
  • Guard sphinx.ext.viewcode behind sys.version_info < (3, 14) to fix a crash in Python 3.14
  • Remove undoc-members from autoapi options (reduces noise)
  • Add test.md to exclude_patterns

Manual RST pages (docs/source/hio.*.rst)

  • Add :no-index: directives to manually-documented modules to resolve duplicate-object-description warnings when autoapi covers the same symbols

README.md

  • Minor line-wrap cleanup (no content change)

Verification

make -C docs clean && make -C docs html
# Build output: 0 warnings, 0 errors
# "build succeeded."
pytest tests/base/test_doing.py tests/base/test_tyming.py tests/base/test_multidoing.py -q
# 32 passed

Pre-existing failures unrelated to this PR:

  • tests/base/test_filing.py::test_filing — path assertion against installed package (fails on main too)
  • tests/core/memo/test_memoing.py — missing MemoerVerifyError in installed package
  • tests/help/test_timing.py — missing AsyncTimer in installed package

@jaelliot
Copy link
Copy Markdown
Contributor Author

This PR appears to be the consolidated follow-up for the earlier split docfmt/docs cleanup PRs. I verified that its file set subsumes the work from #143 and #148-#153, so this is the main HIO docs/docstring cleanup branch to review for the current pass.

For queue hygiene, I’m closing the superseded split PRs and leaving this one open as the aggregate review target.

@SmithSamuelM
Copy link
Copy Markdown
Contributor

This now has conflicts after merged earlier pull requrests. Maybe I misunderstood the order. I merged the oldest ones first.

…tils compliance

- Fix unexpected indentation errors in 30+ source modules by converting
  free-form text blocks to proper RST list items and literal blocks
- Add :no-index: directives to manual .rst pages to resolve duplicate-object
  warnings when autoapi covers the same symbols
- Fix conf.py: expand autoapi_dirs from base/ to full hio package, remove
  undoc-members, guard sphinx.ext.viewcode against Python 3.14 crash
- Add test.md to exclude_patterns
- Minor README.md line-wrap cleanup and typo fixes in docstrings

Build result: 0 warnings, 0 errors (clean from 303+ errors on upstream main)
@jaelliot jaelliot force-pushed the fix/hio-docstring-wave2 branch from d45f549 to c5f9af1 Compare March 18, 2026 17:02
@jaelliot
Copy link
Copy Markdown
Contributor Author

Rebased onto current main (which now includes the merged split PRs #143, #148#153). Conflicts resolved — force-pushed c5f9af1.

After rebase, the net diff is 11 files / 214 ins / 305 del (down from 39 files originally, since the split PRs already landed the rest).

Verified locally:

  • make -C docs clean && make -C docs html0 warnings, 0 errors
  • pytest tests/base/test_doing.py tests/base/test_tyming.py tests/base/test_multidoing.py -q31 passed

Ready for review again.

@jaelliot
Copy link
Copy Markdown
Contributor Author

Queue note after re-checking the three open HIO PRs:

  • #154 is the active aggregate review target and is currently mergeable clean.
  • #152 is now conflict-dirty but its file set is fully subsumed by #154, so I am treating it as superseded unless you want something split back out.
  • #133 is also conflict-dirty, and against current main it has drifted well beyond the original 5-file scope in the PR body. If any of its doing.py / acting.py docstring work is still wanted, the clean path is a fresh minimal follow-up from current main, not rebasing the existing branch.

So from my side, #154 is the one to review/merge for the current docs/docstring cleanup pass.

@SmithSamuelM SmithSamuelM merged commit b52d9d3 into ioflo:main Mar 18, 2026
3 checks passed
@SmithSamuelM
Copy link
Copy Markdown
Contributor

I merged this one $154 so if the other two are obsolete please close them Thanks

@jaelliot jaelliot deleted the fix/hio-docstring-wave2 branch March 29, 2026 00:51
@jaelliot jaelliot restored the fix/hio-docstring-wave2 branch March 29, 2026 00:51
@jaelliot jaelliot deleted the fix/hio-docstring-wave2 branch March 29, 2026 00:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants