docs: Improve --use-type-alias help text documentation#103
Open
staging-devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
docs: Improve --use-type-alias help text documentation#103staging-devin-ai-integration[bot] wants to merge 1 commit intomainfrom
staging-devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
Update the CLI help text for --use-type-alias flag to: - Clarify the feature generates Python type aliases instead of RootModel classes - Document the version matrix: 'type' statement for Python 3.12+, TypeAliasType for Pydantic v2 on 3.10-3.11, and TypeAlias annotation for Pydantic v1 - Note limitations: type aliases don't support model_config or field-specific metadata like default/alias Addresses documentation requirements from issues koxudaxi#2427, koxudaxi#2018, koxudaxi#1285, koxudaxi#1848
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
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.
Summary
Updates the CLI help text for the
--use-type-aliasflag to provide clearer documentation about its functionality and limitations.Changes
The help text for
--use-type-aliashas been updated from:To:
Version Matrix Documentation
The updated help text now documents the following version matrix:
type Name = type(native type statement)Name = TypeAliasType("Name", type)Name: TypeAlias = typeLimitations Documented
The help text now notes that type aliases don't support:
model_configconfigurationdefault,alias, etc.Related Issues
validate_callAnnotatedtypes instead of RootModel wrappers--enum-field-as-literalkoxudaxi/datamodel-code-generator#1285: No way to get reusable TypeAlias definitions with--enum-field-as-literalTypeAliasoutput doesn't account for Python version differencesTesting
All existing type_alias tests pass: