Skip to content

Commit

Permalink
Fix lifecycle docs formatting (#10309)
Browse files Browse the repository at this point in the history
  • Loading branch information
sydney-runkle authored Sep 5, 2024
1 parent 447879b commit eecde7b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/version-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,14 @@ warnings.filterwarnings('ignore', category=PydanticExperimentalWarning)
1. A new feature is added, either in the [`experimental`](api/experimental.md) module or with the `experimental_` prefix.
2. The behavior is often modified during patch/minor releases, with potential API/behavior changes.
3. If the feature is successful, we promote it to Pydantic with the following steps:

a. If it was in the [`experimental`](api/experimental.md) module, the feature is cloned to Pydantic's main module. The original experimental feature still remains in the [`experimental`](api/experimental.md) module, but it will show a warning when used. If the feature was already in the main Pydantic module, we create a copy of the feature without the `experimental_` prefix, so the feature exists with both the official and experimental names. A deprecation warning is attached to the experimental version.

b. At some point, the code of the experimental feature is removed, but there will still be a stub of the feature that provides an error message with appropriate instructions.

c. As a last step, the experimental version of the feature is entirely removed from the codebase.


If the feature is unsuccessful or unpopular, it's removed with little notice. A stub will remain in the location of the deprecated feature with an error message.

Thanks to [streamlit](https://docs.streamlit.io/develop/quick-reference/prerelease) for the inspiration for the lifecycle and naming conventions of our new experimental feature patterns.
Expand Down

0 comments on commit eecde7b

Please sign in to comment.