Skip to content

update squin docs#267

Merged
ryanhill1 merged 2 commits into
mainfrom
rh1-update-squin-docs
Feb 10, 2026
Merged

update squin docs#267
ryanhill1 merged 2 commits into
mainfrom
rh1-update-squin-docs

Conversation

@ryanhill1
Copy link
Copy Markdown
Member

Summary of changes

This pull request improves the documentation and public API exposure for the qbraid_qir.squin module. The main changes are focused on making the module's classes, functions, and exceptions more discoverable and better documented for users.

Documentation improvements:

  • Added detailed docstring sections listing the main functions, classes, and exceptions in the module, including autosummary directives for Sphinx documentation generation.

Public API enhancements:

  • Updated the module imports and __all__ to explicitly expose SquinVisitor and InvalidSquinInput alongside load, making these components officially part of the public API.

@ryanhill1 ryanhill1 marked this pull request as ready for review February 10, 2026 21:22
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@ryanhill1 ryanhill1 merged commit 06a3681 into main Feb 10, 2026
12 checks passed
@ryanhill1 ryanhill1 deleted the rh1-update-squin-docs branch February 10, 2026 21:26
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.

1 participant