Skip to content

Commit

Permalink
update readme and doc conf
Browse files Browse the repository at this point in the history
  • Loading branch information
dakk committed Feb 7, 2024
1 parent 8d67d50 commit f4ebea4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ def search(alist: Qlist[Qint2, 4], to_search: Qint2):
```


Qlasskit function can be parameterized, and the parameter can be bind before compilation:

```python
@qlassf
def test(a: Parameter[bool], b: bool) -> bool:
return a and b

qf = test.bind(a=True)
```


## Roadmap

Read [TODO](TODO.md) for details about the roadmap and TODOs.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "qlasskit"
copyright = "2023, Davide Gessa (dakk)"
copyright = "2023-2024, Davide Gessa (dakk)"
author = "Davide Gessa (dakk)"

# -- General configuration ---------------------------------------------------
Expand Down

0 comments on commit f4ebea4

Please sign in to comment.