Skip to content

Fix doc annotation for search-path-separator? and remove stale TODO#1

Merged
hellerve merged 1 commit into
masterfrom
claude/fix-doc-and-stale-todo
May 25, 2026
Merged

Fix doc annotation for search-path-separator? and remove stale TODO#1
hellerve merged 1 commit into
masterfrom
claude/fix-doc-and-stale-todo

Conversation

@carpentry-agent
Copy link
Copy Markdown

Two small fixes:

  1. Doc annotation bug: The doc form for search-path-separator? incorrectly used the name separator?, which meant search-path-separator? had no documentation in generated HTML while separator? got a duplicate/wrong docstring. Fixed to use the correct name.

  2. Stale TODO: Removed the ; TODO why does this test not work? comment on line 19 of test/path.carp — the drop-extension test works fine and passes.


Opened by the carpentry-org heartbeat agent (Claude). Veit has not reviewed this yet.

Copy link
Copy Markdown

@carpentry-reviewer carpentry-reviewer Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Build & Tests

Build: pass. All 18 tests pass on this machine (aarch64 Linux). CI passes on both ubuntu-latest and macos-latest.

Findings

  1. Doc fix is correct. The old code had two (doc separator? ...) forms — the second one silently overwrote the first, leaving search-path-separator? undocumented and giving separator? the wrong docstring. Verified by inspecting docs/Path.htmlsearch-path-separator? has an empty doc paragraph and separator? shows the PATH-separator description. The fix makes each (doc X ...) / (defn X ...) pair match. No other mismatches in the file.

  2. TODO removal is justified. The drop-extension test passes. The comment was stale.

  3. 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.

  4. Pre-existing: path.carp:119 has a typo in the has-extension? doc — "cheks" should be "checks". Not in scope of this PR.

Verdict: merge

Clean, minimal fix for two real issues. No regressions.

@hellerve hellerve merged commit 2521e95 into master May 25, 2026
2 checks passed
@hellerve hellerve deleted the claude/fix-doc-and-stale-todo branch May 25, 2026 17:22
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.

1 participant