Update changelog.

mpkocher · Aug 23, 2021 · 413d064 · 413d064
1 parent 5d1aa68
commit 413d064
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## Version 4.0.0
+
+- Backward incompatible change for semantics of boolean options
+- `Field` should be used instead of Config.CLI_EXTRA_OPTIONS
+
 ## Version 3.4.0
 
 - Improve support for simple `Enum`s. 

diff --git a/pydantic_cli/core.py b/pydantic_cli/core.py
@@ -34,6 +34,7 @@ class DefaultConfig:
     # Can be used to override custom fields
     # e.g., {"max_records": ('-m', '--max-records')}
     # or {"max_records": ('-m', )}
+    # ****** THIS SHOULD NO LONGER BE USED **** Use pydantic.Field.
     CLI_EXTRA_OPTIONS: T.Dict[str, CustomOptsType] = {}
 
     # Customize the default prefix that is generated