Azure / Azure/azure-functions-durable-python
Add to docs what types are supported out of the box
- Dominant language
- Python
- Stars
- 157
- Forks
- 70
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 2
Description
Feedback from a GBB working with a certain big clothing chain customer.
The customer was trying to return a tuple consisting of a list of custom type and Pandas dataframe. It was not obvious that when an activity function returns, it's actually serialized and deserialized back in the orchestrator function. They were getting error that the tuple didn't implement the `from_json` method .
There is an example in this repo on how to use a custom class as the result, but that's not mentioned anywhere in docs. Would be good to add what types are supported out of the box, i.e. those implementing `to_json` and `from_json`.
Contributor guide
Research direction
Locate the existing repository example showing a custom class as an activity result and review the surrounding documentation. Add a clear explanation of serialization and deserialization, including which types are supported out of the box and the role of to_json and from_json. Include the tuple, custom type, and Pandas dataframe scenario, then verify the documentation is accurate against the existing example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- pandas, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100