[docs] Add Google-style docstring for Signature.with_instructions #8942 #8943
Conversation
gnetsanet
changed the title
|
Hey this looks great. Why "draft"? |
|
I initially planned to include multiple methods in this PR but then decided to keep things atomic. Thanks for the review! I’ll keep this PR scoped to with_instructions. I’ll open a follow-up PR for the next methods per #8926. |
dspy/signatures/signature.py
Outdated
| def with_instructions(cls, instructions: str) -> type["Signature"]: | ||
| """Return a new Signature class with identical fields and new instructions. | ||
| This method does not mutate ``cls``. It constructs a fresh Signature |
There was a problem hiding this comment.
nit: single backtick around variable cls
There was a problem hiding this comment.
- Replaced double backticks around cls with single backtick.
dspy/signatures/signature.py
Outdated
| instructions (str): Instruction text to attach to the new signature. | ||
| Returns: | ||
| type[Signature]: A new Signature class whose fields match ``cls.fields`` |
There was a problem hiding this comment.
same, use single backtick
There was a problem hiding this comment.
- Replaced double backticks around cls with single backtick.
| type[Signature]: A new Signature class whose fields match ``cls.fields`` | ||
| and whose instructions equal ``instructions``. | ||
| Example: |
There was a problem hiding this comment.
this doesn't render on mkdocs, let's use the code block wrapped by triple backtick.
Meanwhile, let's make code example runnable, currently there is no definition of MySig so the code just breaks.
There was a problem hiding this comment.
Thank you.
- Updated docstring example to use triple backtick code block (valid Markdown for mkdocs).
- Added a runnable example (MySig defined explicitly, tested manually and passes).
…ring per style guide
|
Closing in favor of #8945 , which includes the requested fixes and a runnable example. |
3 participants
This PR adds a Google-style docstring for
Signature.with_instructionsin
dspy/signatures/signature.py.Marking as draft; I’ll extend to additional Signature methods per #8926.