Skip to content

Update docstring #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Aug 16, 2025
Merged

Update docstring #154

merged 27 commits into from
Aug 16, 2025

Conversation

paul-paliychuk
Copy link
Contributor

@paul-paliychuk paul-paliychuk commented Aug 16, 2025

Important

Update version to 3.4.1 and improve docstring clarity across multiple files.

  • Version Update:
    • Update version from 3.4.0 to 3.4.1 in package.json, src/Client.ts, and src/version.ts.
  • Docstring Improvements:
    • Clarify context retrieval in reference.md and src/api/resources/thread/client/Client.ts.
    • Update threadId parameter description in reference.md and src/api/resources/thread/client/Client.ts.
    • Change returnContext description in src/api/types/AddThreadMessagesRequest.ts.
    • Revise context description in src/api/types/ThreadContextResponse.ts.

This description was created by Ellipsis for ab961a1. You can customize this summary. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to ab961a1 in 44 seconds. Click for details.
  • Reviewed 96 lines of code in 7 files
  • Skipped 0 files when reviewing.
  • Skipped posting 7 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. package.json:3
  • Draft comment:
    Version updated to 3.4.1. Ensure that downstream integrations and documentation are updated accordingly.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
2. reference.md:993
  • Draft comment:
    The updated description for getUserContext now clearly specifies that it returns context from the user graph (including memory from past threads). This improves clarity—nice work!
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
3. src/Client.ts:48
  • Draft comment:
    Header references updated to version 3.4.1, ensuring consistency across the SDK. This looks good.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
4. src/api/resources/thread/client/Client.ts:380
  • Draft comment:
    Docstring for getUserContext has been enhanced to clarify that it retrieves context from the entire user graph, including past threads. This improved description is helpful.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
5. src/api/types/AddThreadMessagesRequest.ts:17
  • Draft comment:
    The docstring for 'returnContext' now refers to it as a 'context block', which aligns well with the updated terminology in the API. Looks clear and consistent.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
6. src/api/types/ThreadContextResponse.ts:6
  • Draft comment:
    The updated docstring clearly describes that the response contains a context block with relevant facts, entities, and messages/episodes. This is both descriptive and useful.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
7. src/version.ts:1
  • Draft comment:
    SDK_VERSION updated to 3.4.1. This update maintains consistency with all header references.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None

Workflow ID: wflow_ihaNtSGIeyQotzJn

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@paul-paliychuk paul-paliychuk merged commit 43f9bb1 into main Aug 16, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant