Skip to content

Update extract.custom parameter descriptions - #1062

Open
ebhills wants to merge 2 commits into
mainfrom
update-docstrings-for-extractdiy-multimatch
Open

Update extract.custom parameter descriptions#1062
ebhills wants to merge 2 commits into
mainfrom
update-docstrings-for-extractdiy-multimatch

Conversation

@ebhills

@ebhills ebhills commented Jul 12, 2026

Copy link
Copy Markdown
Collaborator
  • incorporated new multi-match capability into recipe wrangle schema
  • made output required --> can't image a case where extract (list) should be slotted into the input (str)
  • add other missing params to core wrangle doc strings

 - added missing params to core wrangle doc strings
 - incorporated new multi-match capability into recipe wrangle schema
@ebhills ebhills added this to the v1.20 milestone Jul 12, 2026
@ebhills
ebhills requested a review from thomasstvr July 12, 2026 11:51
 - add output to required. Never advise to extract into the input column because generally this converts a str to a list
- sequenced the 3 required params as they be expected
@ebhills ebhills self-assigned this Jul 27, 2026
@ebhills
ebhills marked this pull request as draft July 27, 2026 14:03
@ebhills
ebhills removed the request for review from thomasstvr July 27, 2026 14:04

ebhills commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator Author

Queue triage (2026-07-27)

  • Disposition: Draft — delivery-owner action
  • Delivery owner: @ebhills
  • Next action: Fix the failing checks and confirm the schema/API compatibility impact, then request one primary reviewer.

GitHub is the status record; update this PR rather than the external spreadsheet.

@ebhills
ebhills marked this pull request as ready for review August 24, 2026 02:00
@ebhills
ebhills requested a balanced review from Copilot August 24, 2026 02:00

Copilot AI left a comment

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.

Pull request overview

Updates extract.custom documentation and recipe schema for multi-match behavior.

Changes:

  • Documents multi-match outputs and optional parameters.
  • Corrects schema property descriptions.
  • Marks output as required in the generated schema.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
wrangles/recipe_wrangles/extract.py Updates recipe schema and parameter descriptions.
wrangles/extract.py Expands the public function docstring.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

required:
- input
- model_id
- output
Comment on lines +593 to +595
description: |-
Get the first element from results.
If one matched span returns multiple values, only the first value after sorting is kept.
Comment thread wrangles/extract.py
Comment on lines +468 to +469
:param first_element: Return only the first extracted value for each input. If the service returns
multiple values for one matched span, only the first value after sorting is kept.
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