-
Notifications
You must be signed in to change notification settings - Fork 9
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 API documentation to zola docs and fix rust docs #619
Merged
QuantumDancer
merged 2 commits into
ALU-Schumacher:main
from
QuantumDancer:add-api-documentation
Jan 15, 2024
Merged
Add API documentation to zola docs and fix rust docs #619
QuantumDancer
merged 2 commits into
ALU-Schumacher:main
from
QuantumDancer:add-api-documentation
Jan 15, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #619 +/- ##
==========================================
- Coverage 62.97% 62.95% -0.03%
==========================================
Files 46 46
Lines 5823 5825 +2
Branches 74 74
==========================================
Hits 3667 3667
- Misses 2156 2158 +2
|
QuantumDancer
force-pushed
the
add-api-documentation
branch
2 times, most recently
from
January 11, 2024 12:59
63cffa0
to
504ee60
Compare
raghuvar-vijay
previously approved these changes
Jan 11, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks. LGTM! I just mentioned some suggestions.
QuantumDancer
force-pushed
the
add-api-documentation
branch
from
January 12, 2024 09:42
504ee60
to
27e526d
Compare
Thanks a lot for the suggestions. I've updated the docs accordingly. |
The table was not renderd correctly because of rust-lang/rust#65802
QuantumDancer
force-pushed
the
add-api-documentation
branch
from
January 14, 2024 09:40
27e526d
to
b827665
Compare
raghuvar-vijay
approved these changes
Jan 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This closes #597
In addition to the API documentation, this PR also includes a few fixes to the rust documentation (missing code block, table not being rendered correctly due to rust-lang/rust#65802)