[docs]Add Google-Style comprehensive docstring to dspy/primitives/example Example class #8949
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-level docstring following Google Python style guide - Include comprehensive usage examples showing various initialization patterns - Document key features: dictionary-like access, input/output separation, serialization - Cover all major use cases: basic usage, dictionary initialization, copying, input/output handling - Provide practical examples for common operations like iteration, key checking, and field access This improves DSPy's docstring coverage and makes the Example class more accessible to users.
|
Hmm I like this but I'm not the right person to make this decision |
|
ah fair enough, my bad @chenmoneygithub |
dspy/primitives/example.py
Outdated
| - Serialization support for saving/loading examples | ||
| - Immutable operations that return new Example instances | ||
| Args: |
There was a problem hiding this comment.
Args should go to the __init__ method
| and provides convenient methods for handling input/output separation, which is crucial | ||
| for DSPy's training and evaluation workflows. | ||
| Key features: |
There was a problem hiding this comment.
This section reads a bit strange to me, I suggest just deleting that. "standard data format" should be enough IMO
There was a problem hiding this comment.
I have trimmed it down! let me know if i should remove it fully or not?
|
Hey @chenmoneygithub , i've made the fixes as per suggestion and the comments, let me know if I need to make a new PR separately or if we can continue this? |
chenmoneygithub
approved these changes
Oct 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR adds concise Google-style docstrings for example class
✅ No logic or functional changes
This improves DSPy's docstring coverage and makes the Example class more accessible to users.
This is with reference to the issue #8926