Document WellMarkedRetriever in the README#3
Merged
Conversation
The package ships a WellMarkedRetriever (search the web → extract → return Documents) alongside the loader, but the README only covered the loader. Add a Retriever section with its options, and mention it in the intro. Docs only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
CI installs ruff unpinned (`ruff>=0.4`/`>=0.6`) and runs `ruff check .`. A newer ruff release broadened its *default* rule selection to include pyupgrade / flake8-simplify / isort / ruff-native rules, which turned CI red on code that was clean at merge time (UP006/UP007/UP035/UP037/UP045, SIM117/SIM118, I001, RUF012) — none of them E/F errors. Pin `[tool.ruff.lint] select` to ruff's classic default (E4/E7/E9/F) so `ruff check` verifies what these repos were written against regardless of which ruff version CI installs. Adopting the newer rule families is a deliberate migration for a separate PR. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
The package exports a
WellMarkedRetriever(web search → extraction →Documents, Pro+) alongsideWellMarkedLoader, but the README only documented the loader.Adds a Retriever section (usage +
api_key/num_results/render_jsoptions) and mentions it in the intro.Docs-only; no code changes.