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.

Sign up for GitHub

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

Jump to bottom

docs: Crate level description. #666

Closed
aborgna-q opened this issue Nov 9, 2023 · 0 comments · Fixed by #698
Closed

docs: Crate level description. #666

aborgna-q opened this issue Nov 9, 2023 · 0 comments · Fixed by #698
Assignees
@cqc-alec
Labels
documentation Improvements or additions to documentation

Comments

@aborgna-q
Copy link
Collaborator

aborgna-q commented Nov 9, 2023 •
edited
Loading

Expand the crate doc in src/lib.rs, to provide an introduction and links to resources (similar to the README).
Include some doctests showing how this works.
@aborgna-q aborgna-q mentioned this issue Nov 9, 2023
Open
@aborgna-q aborgna-q changed the title Crate level description. docs: Crate level description. Nov 9, 2023
@aborgna-q aborgna-q added the documentation Improvements or additions to documentation label Nov 9, 2023
@cqc-alec cqc-alec self-assigned this Nov 15, 2023
@cqc-alec cqc-alec mentioned this issue Nov 15, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Nov 15, 2023
@cqc-alec
docs: Improve crate-level docs, including example code. (#698)
3938883 
Closes #666 .
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cqc-alec cqc-alec

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Improve crate-level docs, including example code. CQCL/hugr
2 participants
@cqc-alec @aborgna-q