Add docstrings for python wrappers

qognitive · Oct 3, 2024 · 560a957 · 560a957
1 parent f8846bb
commit 560a957
Show file tree

Hide file tree

Showing 2 changed files with 663 additions and 164 deletions.
diff --git a/fast_pauli/__init__.py b/fast_pauli/__init__.py
@@ -1,4 +1,4 @@
-"""Fast Pauli and helpers."""
+""":code:`fast_pauli` is a Python package with C++ backend, optimized for operations on Pauli Matrices and Pauli Strings."""  # noqa: E501
 
 from ._fast_pauli import (  # noqa: F401
     Pauli,