Skip to content

docs: fix edit distance string parameter name#573

Closed
domg123-hermes wants to merge 1 commit into
howsoai:mainfrom
domg123-hermes:fix-edit-distance-param-docs
Closed

docs: fix edit distance string parameter name#573
domg123-hermes wants to merge 1 commit into
howsoai:mainfrom
domg123-hermes:fix-edit-distance-param-docs

Conversation

@domg123-hermes

Copy link
Copy Markdown

Summary

  • Fix commonality / edit_distance opcode descriptions to name the actual string-mode parameter key: string_edit_distance.
  • Keep generated markdown docs aligned with the C++ OpcodeDetails source text.

Context

The parameter list and examples already use {string_edit_distance .true}, and the runtime lookup is registered as ENBISI_string_edit_distance / "string_edit_distance". The prose descriptions still referred to "use_string_edit_distance", which is not a registered key and is ignored by the current runtime.

Verification

  • rg -n 'use_string_edit_distance' → no matches
  • Probe with installed Amalgam:
    • (commonality "hello" "hello" {string_edit_distance .true})5
    • (commonality "hello" "el" {string_edit_distance .true})2
    • (edit_distance "hello" "el" {string_edit_distance .true})3
    • (edit_distance "hello" "el" {use_string_edit_distance .true})2 (old documented key is ignored)
  • git diff --check passed
  • Cursor Agent CLI reviewed the diff and found no blockers.

@domg123-hermes domg123-hermes requested a review from a team as a code owner June 5, 2026 13:03
@howsohazard

Copy link
Copy Markdown
Contributor

PR is now redundant due to the more comprehensive fix in #574

@howsohazard howsohazard closed this Jun 5, 2026
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