example for unliteral

RocketRace · Mar 31, 2022 · 2290c65 · 2290c65
1 parent 1dc7844
commit 2290c65
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,19 @@ class Duration:
 
 print(30 .s + 0.5.m) # 0:01:00
 ```
+Removing a custom literal:
+```py
+from custom_literals import literal, unliteral
+
+@literal(str)
+def u(self):
+    return self.upper()
+
+print("hello".u) # "HELLO"
+
+unliteral(str, "u")
+assert not hasattr("hello", "u")
+```
 Context manager syntax:
 ```py
 from custom_literals import literally

diff --git a/custom_literals.py b/custom_literals.py
@@ -41,6 +41,19 @@ def m(self):
 
 print(30 .s + 0.5.m) # 0:01:00
 ```
+Removing a custom literal:
+```py
+from custom_literals import literal, unliteral
+
+@literal(str)
+def u(self):
+    return self.upper()
+
+print("hello".u) # "HELLO"
+
+unliteral(str, "u")
+assert not hasattr("hello", "u")
+```
 Context manager syntax:
 ```py
 from custom_literals import literally