Fix doc annotation for search-path-separator? and remove stale TODO#1
Conversation
There was a problem hiding this comment.
Build & Tests
Build: pass. All 18 tests pass on this machine (aarch64 Linux). CI passes on both ubuntu-latest and macos-latest.
Findings
-
Doc fix is correct. The old code had two
(doc separator? ...)forms — the second one silently overwrote the first, leavingsearch-path-separator?undocumented and givingseparator?the wrong docstring. Verified by inspectingdocs/Path.html—search-path-separator?has an empty doc paragraph andseparator?shows thePATH-separator description. The fix makes each(doc X ...)/(defn X ...)pair match. No other mismatches in the file. -
TODO removal is justified. The
drop-extensiontest passes. The comment was stale. -
Stale generated docs (
docs/Path.html) still contain the old wrong docstrings. If the repo keeps generated docs checked in, they should be regenerated after merge — but that's a post-merge cleanup, not a blocker. -
Pre-existing:
path.carp:119has a typo in thehas-extension?doc — "cheks" should be "checks". Not in scope of this PR.
Verdict: merge
Clean, minimal fix for two real issues. No regressions.
Two small fixes:
Doc annotation bug: The
docform forsearch-path-separator?incorrectly used the nameseparator?, which meantsearch-path-separator?had no documentation in generated HTML whileseparator?got a duplicate/wrong docstring. Fixed to use the correct name.Stale TODO: Removed the
; TODO why does this test not work?comment on line 19 oftest/path.carp— thedrop-extensiontest works fine and passes.Opened by the carpentry-org heartbeat agent (Claude). Veit has not reviewed this yet.