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

docs: Add compiler API docs #194

Merged
merged 9 commits into from
Apr 16, 2024
Merged

docs: Add compiler API docs #194

merged 9 commits into from
Apr 16, 2024

Conversation

mark-koch
Copy link
Collaborator

@mark-koch mark-koch commented Apr 11, 2024

See https://cqcl.github.io/guppylang/api-docs/ for the deployed docs

@codecov-commenter
Copy link

codecov-commenter commented Apr 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.67%. Comparing base (ae71932) to head (2ba2f13).

Additional details and impacted files
@@            Coverage Diff            @@
##           main     #194       +/-   ##
=========================================
+ Coverage      0   90.67%   +90.67%     
=========================================
  Files         0       46       +46     
  Lines         0     4717     +4717     
=========================================
+ Hits          0     4277     +4277     
- Misses        0      440      +440     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mark-koch mark-koch marked this pull request as ready for review April 11, 2024 13:52
@mark-koch mark-koch requested a review from aborgna-q April 11, 2024 13:54
Comment on lines +426 to 427
#: The type of parametrized Guppy types.
ParametrizedType: TypeAlias = FunctionType | TupleType | SumType | OpaqueType
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to add these #: docstrings to all type aliases and also do from __future__ import annotations everywhere to make it work. I'll leave that to another PR

docs/api-docs/conf.py Outdated Show resolved Hide resolved
.github/workflows/docs.yml Outdated Show resolved Hide resolved
mark-koch and others added 3 commits April 16, 2024 13:42
@mark-koch mark-koch merged commit c3dd9bd into main Apr 16, 2024
3 checks passed
@mark-koch mark-koch deleted the docs/api branch April 16, 2024 12:54
@mark-koch mark-koch mentioned this pull request Apr 17, 2024
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.

3 participants