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 DD package #814

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

📝 Add documentation for DD package #814

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

Comments

@burgholzer
Copy link
Member

The DD package currently has no real documentation besides the documentation of the evaluation functionality.
This is a tracking issue for adding such documentation.

At the bare minimum, this should document the main C++ used to interact with the package and add a dedicated documentation section explaining the main features and limitations.
To achieve this, it might be worth considering exposing the DD package to Python and documenting the corresponding Python stubs (similar to how this is done for the IR submodule of MQT Core).

@burgholzer burgholzer added DD Anything related to the DD package documentation Improvements or additions to documentation labels Jan 24, 2025
@burgholzer burgholzer added this to the DD Package Improvements milestone Jan 24, 2025
@burgholzer burgholzer self-assigned this Jan 24, 2025
@burgholzer burgholzer added this to MQT Core and MQT 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
@burgholzer burgholzer linked a pull request Feb 17, 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
DD Anything related to the DD package documentation Improvements or additions to documentation
Projects
Status: In Progress
Status: In Progress
Development

Successfully merging a pull request may close this issue.

1 participant