📝 Updated the docs to note the Union[X, None] and X | None support (

#10)
Luttik · Oct 5, 2021 · 3f904c3 · 3f904c3
1 parent 9eddc04
commit 3f904c3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -78,8 +78,11 @@ After installing you can run auto-optional using `auto-optional [path]` (path is
 
 ### Things that are handled well
 
+- The alternatives to `Optional` are supported, that means both;
+    - `Union[X, None]`
+    - `x | None` (allowed since python 10+).
 - Existing imports are reused.
-- `import as` statements are properly handled.
+    - `import as` and `from typing import ...` statements are properly handled.
 
 ### Things that need improvement
 For all these points you can leave a thumbs-up if you want it. Also, I welcome pull-requests for these issues.

diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,5 @@
 # Auto-optional
-<img src="https://raw.githubusercontent.com/Luttik/auto-optional/main/docs/assets/images/logo-with-text.svg" style="width: 100%; margin: 32pt 0" alt="Logo">
+<img src="/assets/images/logo-with-text.svg" style="width: 100%; margin: 32pt 0" alt="Logo">
 
 
 <p align="center">
@@ -78,8 +78,11 @@ After installing you can run auto-optional using `auto-optional [path]` (path is
 
 ### Things that are handled well
 
+- The alternatives to `Optional` are supported, that means both;
+    - `Union[X, None]`
+    - `x | None` (allowed since python 10+).
 - Existing imports are reused.
-- `import as` statements are properly handled.
+    - `import as` and `from typing import ...` statements are properly handled.
 
 ### Things that need improvement
 For all these points you can leave a thumbs-up if you want it. Also, I welcome pull-requests for these issues.