Readme and docs #1155
Merged
Readme and docs #1155
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation by modifying code examples and wording in the README to reflect updated usage of typing generics and installation commands. Key changes include:
- Updating type hints in code examples from typing generics (List, Dict) to Python built-in generics (list, dict).
- Adjusting the phone number demonstration by incorporating Annotated types with Field and updating the phone string example.
- Refining the README description and installation command for clarity.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/functions/generate.mdx | Changed type hints to built-in generics for generating examples. |
| docs/functions/cast.mdx | Updated phone-casting example with Annotated types and Field validation. |
| README.md | Revised description and installation command for improved clarity. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.