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

📝 Add documentation for ZX package #813

Open
burgholzer opened this issue Jan 24, 2025 · 0 comments · May be fixed by #817
Open

📝 Add documentation for ZX package #813

burgholzer opened this issue Jan 24, 2025 · 0 comments · May be fixed by #817
Assignees
Labels
documentation Improvements or additions to documentation ZX Anything related to the ZX package

Comments

@burgholzer
Copy link
Member

The ZX package currently has no real documentation. Neither in it's public API nor in the actual documentation hosted on RtD.
This is a tracking issue for adding such documentation.
At the bare minimum, this should document all public methods in C++ and add a dedicated documentation section explaining the main features and limitations.

@burgholzer burgholzer added documentation Improvements or additions to documentation ZX Anything related to the ZX package labels Jan 24, 2025
@burgholzer burgholzer added this to the ZX Package Improvements milestone Jan 24, 2025
@burgholzer burgholzer added this to MQT and MQT Core Jan 24, 2025
@github-project-automation github-project-automation bot moved this to In Progress in MQT Jan 24, 2025
@github-project-automation github-project-automation bot moved this to In Progress in MQT Core Jan 24, 2025
@pehamTom pehamTom linked a pull request Jan 27, 2025 that will close this issue
4 tasks
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 ZX Anything related to the ZX package
Projects
Status: In Progress
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants