Repository navigation
Document complete search-result scoring and outputs - #1230
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linked issue
Refs #1227 — release-planning context: PY 1.20.5; this PR does not close the release-planning issue.
Documentation follow-up to merged #1229.
What changes
Expand
docs/search_result_scoring.mdfrom a part-code evidence guide into a complete description ofcompute.score_search_results, using section headings, tables, recipe examples, and worked outputs rather than an implementation walkthrough.The workstream is
document-search-scoring. The scoring implementation, numeric defaults, result field names, and matching/reduction behavior are unchanged.How it was verified
Local validation on this branch:
.venv/Scripts/python.exe -m pytest -c pytest-local.ini tests/recipes/wrangles/test_compute.py -q --tb=short— 36 passed.scripts/test-local.ps1— 3,023 passed, 6 skipped, 139 deselected on Windows / Python 3.13.1 (180.29 seconds).scripts/check_pytest_local_config.py— passed; 67 test files, 8 ignores, and 22 deselects checked.schema/generate_recipe_schema.py— schema generation and Draft7 validation passed; generated JSON is not committed.origin/main: zero commits behind, one focused commit ahead;git diff --checkandgit merge-tree --write-tree origin/main HEADpassed. Only five intended files are changed.GitHub Actions CI run 38166137004 is in progress for commit
5392ec98; no CI pass is claimed yet. No live provider, WrangleWorks-service, deployment, or package-publication checks were performed.Compatibility and risk
This is documentation, schema metadata, and offline test work; the scoring algorithm and runtime signatures/defaults are unchanged. Supported recipes keep their existing mappings and result shapes.
Generated schema validation now explicitly rejects input/output column counts outside the documented contract and non-string column names. Consumers relying on unsupported configuration shapes may therefore see validation errors. The guide also makes existing heuristic limitations visible; it does not change them.
No new dependencies, credentials, version bump, deployment, or release publication are included. Rollback is a revert of this focused documentation/schema/test commit; no data migration is required.
Ready-for-review checklist
ebhillsv1.20, targeting PY 1.20.5mainand has no merge conflictsDraft handoff: local work and validation are complete. The repository currently has five Ready PRs, so keep this PR Draft while CI is pending and the Ready queue is full. Once checks pass and a slot is available, the assignee should mark it Ready and request one primary reviewer. Opening this PR does not authorize merging.
See the pull request workflow.