[Bug] Fix explanation of Pydantic datetime issue

Open Beginner friendly
#496 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

bug
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.

Dominant language
Python
Stars
1.2k
Forks
241
Avg merge
3d 2h
Merged PRs (30d)
49

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from temporalio/sdk-python

All issues in temporalio/sdk-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.