docs: clarify from field accessed as from_ in Python SDK#107
Open
shuklaji28 wants to merge 1 commit into
Open
Conversation
Updated 'from' field to include type and documentation for Python SDK usage.The `from` field in MessageItem and Message types is a reserved keyword in Python. Added documentation notes to clarify that Python SDK users must access this field as `from_` (e.g. `message.from_`). The alias="from" in the SDK handles JSON serialization correctly, but this was not documented.
Contributor
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="fern/definition/messages.yml">
<violation number="1" location="fern/definition/messages.yml:119">
P1: Malformed indentation in `Message.properties` breaks YAML/Fern structure and moves `reply_to` out of the `Message` schema.</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Add one-off context when rerunning by tagging
@cubic-dev-aiwith guidance or docs links (includingllms.txt) - Ask questions if you need clarification on any suggestion
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| from: | ||
| type: MessageFrom | ||
| docs: Address of sender. Note - since `from` is a reserved keyword in Python, access this field as `from_` when using the Python SDK (e.g. `message.from_`). | ||
| reply_to: |
Contributor
There was a problem hiding this comment.
P1: Malformed indentation in Message.properties breaks YAML/Fern structure and moves reply_to out of the Message schema.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At fern/definition/messages.yml, line 119:
<comment>Malformed indentation in `Message.properties` breaks YAML/Fern structure and moves `reply_to` out of the `Message` schema.</comment>
<file context>
@@ -111,8 +113,10 @@ types:
+ from:
+ type: MessageFrom
+ docs: Address of sender. Note - since `from` is a reserved keyword in Python, access this field as `from_` when using the Python SDK (e.g. `message.from_`).
+reply_to:
type: optional<list<string>>
docs: Reply-to addresses. In format `username@domain.com` or `Display Name <username@domain.com>`.
</file context>
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
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.
Updated 'from' field to include type and documentation for Python SDK usage.The
fromfield in MessageItem and Message types is a reserved keyword in Python. Added documentation notes to clarify that Python SDK users must access this field asfrom_(e.g.message.from_). The alias="from" in the SDK handles JSON serialization correctly, but this was not documented.Summary by cubic
Clarified Python SDK usage of the
fromfield: access it asfrom_(e.g.,message.from_) becausefromis a Python keyword. Updated theMessageandMessageItemschemas infern/definition/messages.ymlwith type and docs; JSON still serializes asfrom.Written for commit 7f1630b. Summary will update on new commits.