langgraph icon indicating copy to clipboard operation
langgraph copied to clipboard

docs: Add Version 0.2.24 Documentation to for PregelTask, PregelExecutableTask, StateSnapshot, Send

Open YassinNouh21 opened this issue 9 months ago • 7 comments

Changes

Added version documentation to classes and functions introduced in version 0.2.24:

  • PregelTask class
  • PregelExecutableTask class
  • StateSnapshot class
  • Send class

Why

Improves code maintainability by clearly indicating when these types were introduced in the codebase.

YassinNouh21 avatar Mar 28 '25 02:03 YassinNouh21

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
langgraph-docs-preview ⬜️ Ignored (Inspect) Visit Preview Mar 28, 2025 2:45am

vercel[bot] avatar Mar 28 '25 02:03 vercel[bot]

@eyurtsev caan u check this

YassinNouh21 avatar Mar 28 '25 09:03 YassinNouh21

Improves code maintainability by clearly indicating when these types were introduced in the codebase.

I'd probably say that this is much more useful for our end users than for internal development. End users may need to know sometimes that a feature is not available for their current version

eyurtsev avatar Mar 28 '25 17:03 eyurtsev

Improves code maintainability by clearly indicating when these types were introduced in the codebase.

I'd probably say that this is much more useful for our end users than for internal development. End users may need to know sometimes that a feature is not available for their current version

Could u suggest some to work on

YassinNouh21 avatar Mar 28 '25 17:03 YassinNouh21

@eyurtsev I checked the history of types.py, and it looks like at some point, the entire file was either moved or significantly changed—including PregelTask, which you mentioned.

I followed your suggested steps and created a release based on that version, but let me know if I misunderstood anything or if there’s a better way to approach it. I just want to make sure the GitHub diff actions correctly reflect when PregelTask was added to the class.

Here are the relevant links for reference: GitHub Link 1 GitHub Link 2

Let me know what you think!

YassinNouh21 avatar Mar 28 '25 18:03 YassinNouh21

Use version-added for when the object / type was introduced into langgraph.

version-modified can be used to capture modifications (e.g., changing namespaces for the type etc.)

eyurtsev avatar Mar 31 '25 15:03 eyurtsev

Use version-added for when the object / type was introduced into langgraph.

version-modified can be used to capture modifications (e.g., changing namespaces for the type etc.)

Ok thanks for the clarification. I will remove it

YassinNouh21 avatar Mar 31 '25 15:03 YassinNouh21