Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Improve QuantumModel docstrings #487

Merged
merged 6 commits into from
Jul 3, 2024
Merged

Conversation

chMoussa
Copy link
Collaborator

@chMoussa chMoussa commented Jul 2, 2024

Closes #483

@chMoussa chMoussa self-assigned this Jul 2, 2024
@dominikandreasseitz dominikandreasseitz changed the title Improve QuantumModel docstrings [Documentation] Improve QuantumModel docstrings Jul 2, 2024
@awennersteen
Copy link
Member

Super nice,
Maybe whilst we're here we can add usage examples to the QuantumModel class

    Example:
    ```python exec="on" source="material-block" result="json"
    from qadence import QuantumModel, QuantumCircuit, <some gates>
    

    ```
    ```

@chMoussa chMoussa added the documentation Improvements or additions to documentation label Jul 3, 2024
Copy link
Collaborator

@jpmoutinho jpmoutinho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice @chMoussa 👍

@chMoussa chMoussa merged commit bfd4c4c into main Jul 3, 2024
8 checks passed
@chMoussa chMoussa deleted the cm/qmodel_doc branch July 3, 2024 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve QuantumModel docstrings
3 participants