summaryrefslogtreecommitdiff
path: root/candle-pyo3/_additional_typing/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'candle-pyo3/_additional_typing/README.md')
-rw-r--r--candle-pyo3/_additional_typing/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/candle-pyo3/_additional_typing/README.md b/candle-pyo3/_additional_typing/README.md
new file mode 100644
index 00000000..ab5074e0
--- /dev/null
+++ b/candle-pyo3/_additional_typing/README.md
@@ -0,0 +1,3 @@
+This python module contains external typehinting for certain `candle` classes. This is only necessary for `magic` methodes e.g. `__add__` as their text signature cant be set via pyo3.
+
+The classes in this module will be parsed by the `stub.py` script and interleafed with the signatures of the actual pyo3 `candle.candle` module. \ No newline at end of file