📝 Improved the project description

Luttik · Sep 11, 2021 · 2ad38e7 · 2ad38e7
1 parent 7d39910
commit 2ad38e7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 
 
 <p align="center">
-    auto-optional: Makes typed arguments Optional when the default argument is None.
+    auto-optional: adds the Optional type-hint to arguments where the default value is None
 </p>
 
 <p align="center">

diff --git a/docs/index.md b/docs/index.md
@@ -3,7 +3,7 @@
 
 
 <p align="center">
-    auto-optional: Makes typed arguments Optional when the default argument is None.
+    auto-optional: adds the Optional type-hint to arguments where the default value is None
 </p>
 
 <p align="center">
@@ -35,7 +35,7 @@
 
 ---
 
-## What does auto-optional do?
+## What does auto-optional do
 The basic purpose of auto-optional is ensuring that whenever a default argument is `None` the type annotation is Optional.
 
 For example:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "auto-optional"
 version = "0.1.0"
-description = "Makes typed arguments Optional when the default argument is None"
+description = "Adds the Optional type-hint to arguments where the default value is None"
 authors = ["Luttik <[email protected]>"]
 readme = "README.md"
 repository = "https://github.com/Luttik/auto-optional"