temporalio / temporalio/sdk-python
[Bug] Fix explanation of Pydantic datetime issue
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 241
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 55
Description
Describe the bug
Today the README says to mark datetime as passthrough, but the right answer is to mark it as unrestricted. Fix this in README, and also consider providing snippet from https://github.com/temporalio/samples-python/blob/4303a9b15f4ddc4cd770bc0ba33afef90a25d3ae/pydantic_converter/worker.py#L45-L65.
Also clarify in README that you should pass through non-workflow imports, not just third party.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the README sections describing Pydantic datetime handling and passthrough imports, then compare the referenced samples-python pydantic_converter/worker.py lines 45-65. Update the explanation to distinguish unrestricted datetime handling from passthrough and clarify which non-workflow imports should be passed through. Done means the README reflects both corrections and includes the requested snippet if appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100