Repository navigation
fix: correct and complete the langchain-decodo README - #22
Open
pauliusminialga-dc wants to merge 1 commit into
Open
pauliusminialga-dc wants to merge 1 commit into
pauliusminialga-dc wants to merge 1 commit into
Conversation
The README is what PyPI serves on the project page, so these inaccuracies are user-facing on every install. - Removed Reddit from the DecodoSearchTool section: the prose, the example and the engines table. Reddit is not documented on any public Decodo surface. - Documented DecodoLoader's constructor arguments, which were missing entirely: api_token, auth_mode, timeout and continue_on_error. Added the task_id/created_at/updated_at metadata and what continue_on_error does to a failed URL. - Replaced the deprecated .run() with .invoke() in the two scrape-tool examples, so the whole README uses one API. - Documented num_results, and the two DecodoSearchTool behaviours that surprise people: engine= on the constructor is a no-op, and num_results does not cap the results the API returns. Documentation only; no source changes, so DecodoSearchTool still accepts every engine value it accepted before. Typed `fix:` rather than `docs:` deliberately. python-semantic-release lists only fix, perf and hotfix in patch_tags, so a `docs:` title cuts no release and the README on PyPI would stay at the 0.2.0 text indefinitely.
This branch has not been deployed
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.
What
Documentation-only corrections to
libs/partners/decodo/README.md. No source changes, so nothing about the package's behaviour moves.This is the text PyPI renders on the langchain-decodo project page, so every inaccuracy in it is user-facing on every install.
Changes
Reddit removed from the
DecodoSearchToolsection — the prose, the example call and the engines table row. Reddit is not documented on any public Decodo surface, and the equivalent cleanup has already landed on the Mintlify pages and the TypeScript package.Note this is a README change only.
_ENGINE_TARGET_MAPintools.pyis untouched, soengine="reddit"still works exactly as before for anyone already passing it. Whether the source should change too is a separate decision.DecodoLoader's constructor arguments documented. The section listed none of them. Addedurls,api_token,auth_mode,timeoutandcontinue_on_error, plus thetask_id,created_atandupdated_atmetadata the loader carries through, and whatcontinue_on_erroractually does to a failed URL (emptypage_content, error inmetadata["error"], which you want to filter out before embedding)..run()replaced with.invoke()in the two scrape-tool examples. The four newer tools already used.invoke(), so the README was demonstrating two different APIs, one of them deprecated.Two
DecodoSearchToolbehaviours documented that currently surprise people, along withnum_resultsitself:engine=on the constructor is a no-op._runtakesenginefrom the args schema, which defaults togoogle, soDecodoSearchTool(engine="amazon")still searches Google. Passengineper call.num_resultsdoes not cap the results returned. It is sent aslimit, and a Google search withnum_results=3still comes back with the full first page of organic results.Both were already documented on
help.decodo.com; this brings the README in line.Why
fix:and notdocs:Deliberate.
python-semantic-releaseis configured inpyproject.tomlwithpatch_tags = ["fix", "perf", "hotfix"], so adocs:title cuts no release. PyPI serves the README from the last published version, which means the 0.2.0 text — Reddit included — would stay on the project page indefinitely.fix:cuts 0.2.1 and republishes the corrected README. If you would rather not cut a release for this, retitle todocs:before merging and the text will land in the repo but not on PyPI.Verification
langchain_decodoatmaster: loader defaultstimeout=180andcontinue_on_error=True,num_results1–100 default 10, the engine map, and the_runsignature that makes the constructorenginea no-op.grep -ic redditon the pushed file returns 0;grep -c '\.run('returns 0.