docs: add examples to Language.__call__ and pipe() methods#13945
Open
mokshagnachintha wants to merge 1 commit intoexplosion:masterfrom
Open
docs: add examples to Language.__call__ and pipe() methods#13945mokshagnachintha wants to merge 1 commit intoexplosion:masterfrom
mokshagnachintha wants to merge 1 commit intoexplosion:masterfrom
Conversation
- Add comprehensive examples to __call__ method showing basic usage, multi-sentence processing, named entity extraction, and disabling components - Add detailed examples to pipe() method demonstrating batch processing, context handling with as_tuples, batch_size optimization, component disabling, and multiprocessing usage - Examples follow spaCy documentation style with doctest format - Improves discoverability of core API features for new users
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
This PR enhances the documentation of two core Language class methods with comprehensive, practical examples to improve discoverability and reduce the learning curve for new spaCy users.
Changes
Enhanced Language.call() docstring with 5 usage examples:
Enhanced Language.pipe() docstring with 6 usage examples:
Why This Matters
Type of Change
Testing
Checklist