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

Improve Sphinx documentation for PyQIR Generator #155

Merged
merged 3 commits into from
Sep 2, 2022

Conversation

bamarsha
Copy link
Contributor

  • Move the docstrings from .pyi to Rust doc comments, so PyO3 attaches them to the Python __doc__ attribute.
  • Add parameter types and return types to the docstrings (this duplicates information still in the .pyi file).
  • Add text_signature attributes.

This approach unfortunately has a lot of information duplication, but it seems like this is just where the state of the tooling is for creating Python native modules with good documentation. Some of the open issues in the toolchain:

Closes #62.

@bamarsha bamarsha merged commit 2194614 into main Sep 2, 2022
@bamarsha bamarsha deleted the samarsha/generator-docs branch September 2, 2022 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PyQIR generator documentation is incomplete
2 participants