docs: Update return types for arun() and arun_many() to RunManyReturn (#1543)#1716
Open
YuriNachos wants to merge 1 commit intounclecode:mainfrom
Open
docs: Update return types for arun() and arun_many() to RunManyReturn (#1543)#1716YuriNachos wants to merge 1 commit intounclecode:mainfrom
YuriNachos wants to merge 1 commit intounclecode:mainfrom
Conversation
Fixes unclecode#1543 The documentation was incorrectly stating that: - arun() returns CrawlResult - arun_many() returns Union[List[CrawlResult], AsyncGenerator[CrawlResult, None]] However, both methods actually return RunManyReturn. This caused issues with IDE auto-completion and type hints. Updated: - docs/md_v2/api/async-webcrawler.md: Fixed return type for arun() and arun_many() - docs/md_v2/api/arun_many.md: Fixed return type and related descriptions Co-Authored-By: Claude <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.
🎯 Summary
Fixes #1543
📝 Description
The documentation was incorrectly stating that
arun()returnsCrawlResultandarun_many()returnsUnion[List[CrawlResult], AsyncGenerator[CrawlResult, None]]. However, both methods actually returnRunManyReturn, causing issues with IDE auto-completion and type hints.🔧 Changes
docs/md_v2/api/async-webcrawler.md:
CrawlResulttoRunManyReturnList[CrawlResult]toRunManyReturndocs/md_v2/api/arun_many.md:
Union[List[CrawlResult], AsyncGenerator[CrawlResult, None]]toRunManyReturnRunManyReturncontains either a list of results or an async generator✅ Actual Return Types (from source code)
Co-Authored-By: Claude noreply@anthropic.com