Skip to content

docs(web): improve documentation for SearchSpace and SearchNode#14555

Merged
jahorton merged 2 commits intomasterfrom
docs/web/correction-search-internals
Aug 20, 2025
Merged

docs(web): improve documentation for SearchSpace and SearchNode#14555
jahorton merged 2 commits intomasterfrom
docs/web/correction-search-internals

Conversation

@jahorton
Copy link
Copy Markdown
Contributor

Build-bot: skip
Test-bot: skip

@keymanapp-test-bot
Copy link
Copy Markdown

User Test Results

Test specification and instructions

User tests are not required

@github-actions github-actions bot added docs and removed docs labels Aug 19, 2025
Copy link
Copy Markdown
Member

@mcdurdin mcdurdin left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the additional code docs!


// While this may SEEM to be unnecessary, note that sometimes substitutions (which are computed
// via insert + delete) may be lower cost than both just-insert and just-delete.
/**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are the 2 lines above applicable to buildSubstitutionEdges?

Copy link
Copy Markdown
Contributor Author

@jahorton jahorton Aug 20, 2025

Choose a reason for hiding this comment

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

They are, but it's more of an internal implementer's note, as to why I wrote the design the way it is all the way back then - that's why they're outside of the doc-comment.

Copy link
Copy Markdown
Contributor

@darcywong00 darcywong00 left a comment

Choose a reason for hiding this comment

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

lgtm

@jahorton jahorton merged commit 5c79e30 into master Aug 20, 2025
6 checks passed
@jahorton jahorton deleted the docs/web/correction-search-internals branch August 20, 2025 17:52
@github-project-automation github-project-automation bot moved this from Todo to Done in Keyman Aug 20, 2025
@keyman-server
Copy link
Copy Markdown
Collaborator

Changes in this pull request will be available for download in Keyman version 19.0.103-alpha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants