docs: add comprehensive docstrings to PdfPipelineOptions #2827
+137
−36
Conversation
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
- Add detailed class docstring with parameter descriptions - Include 4 complete usage examples (digital PDF, scanned PDF, scientific papers, Databricks) - Document production considerations (timeouts, OCR engines, distributed systems) - Preserve existing inline comments and type hints - Add cross-references to related classes Addresses docling-project#2747
Contributor
|
✅ DCO Check Passed Thanks @panwarnalini-hub, all your commits are properly signed off. 🎉 |
|
Related Documentation Checked 10 published document(s) in 1 knowledge base(s). No updates required. How did I do? Any feedback? |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
I, Nalini Panwar <[email protected]>, hereby add my Signed-off-by to this commit: 47ae0483c9a5eeba6d0cda8595d35b09b7 Signed-off-by: Nalini Panwar <[email protected]>
I, Nalini Panwar <[email protected]>, hereby add my Signed-off-by to this commit: 47ae048 Signed-off-by: Nalini Panwar <[email protected]>
I, Nalini Panwar <[email protected]>, hereby add my Signed-off-by to this commit: 47ae048 Signed-off-by: Nalini Panwar <[email protected]>
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
Adds comprehensive docstrings to
PdfPipelineOptionsclass with detailed parameter documentation and production usage examples.Changes
PdfPipelineOptionsMotivation
Addresses #2747 - improves developer experience by providing clear documentation for pipeline configuration options based on real production usage.
Examples included
Based on production experience with clinical trial document processing using Docling v2.