Skip to content

Conversation

@miparnisari
Copy link
Contributor

@miparnisari miparnisari commented Sep 9, 2025

Description

  • Update the existing code snippets
  • Add a new snippet to explain the INCLUDE_CHECKPOINTS request param

Testing

Locally

References

@vercel
Copy link

vercel bot commented Sep 9, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Sep 9, 2025 11:53pm

To subscribe to receive watch changes, the `Watch` API call is made:
To receive watch changes, call the `Watch` API. This is a streaming API that will continually return all updates to relationships from the time at which the API call was made.

```py
Copy link
Contributor Author

@miparnisari miparnisari Sep 9, 2025

Choose a reason for hiding this comment

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

Ideally we have code snippets for every SDK :( I also feel like in the intro we should describe use cases for this api, maybe link it to materialize

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, agreed. I've seen some doc sites that do some nifty inclusion from the underlying codebases using special comments... that'd be rad to have at some point.

@miparnisari miparnisari marked this pull request as ready for review September 9, 2025 23:49
Copy link
Contributor

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

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

LGTM

To subscribe to receive watch changes, the `Watch` API call is made:
To receive watch changes, call the `Watch` API. This is a streaming API that will continually return all updates to relationships from the time at which the API call was made.

```py
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, agreed. I've seen some doc sites that do some nifty inclusion from the underlying codebases using special comments... that'd be rad to have at some point.

@tstirrat15 tstirrat15 merged commit e0dc6c4 into main Sep 11, 2025
10 checks passed
@tstirrat15 tstirrat15 deleted the update-watch-docs branch September 11, 2025 16:02
@github-actions github-actions bot locked and limited conversation to collaborators Sep 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants