Document the public API and organize the docs pages#188
Merged
Conversation
Documents the public API and organizes the docs into curated pages. The exported and `@compat public` names now carry docstrings with examples, and the index and tensor accessors and operator helpers that ITensorNetworksNext already relies on are now exported. The docs gain a User Interface page (the stable index, tensor, constructor, algebra, and broadcasting API, organized by topic) and a Developer Interface page (the named-array types and operations for implementing a tensor type, plus the experimental operator API), alongside the auto-generated Reference. Also adds `aligneddims`, the view counterpart of `aligndims`, and drops the unused `to_inds` from the public list. Bumps the version to 0.8.4.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #188 +/- ##
==========================================
+ Coverage 72.22% 72.77% +0.54%
==========================================
Files 28 28
Lines 1480 1480
==========================================
+ Hits 1069 1077 +8
+ Misses 411 403 -8
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
The tensor show method qualifies the element type relative to the active module, so `using ITensorBase: ITensorBase` left the doctests and `@example` outputs rendering `ITensorBase.ITensor` instead of `ITensor`, which failed the doctest comparison.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Documents the public API and organizes the docs into curated pages. The exported and
@compat publicnames now carry docstrings with examples, and the index and tensor accessors and operator helpers that ITensorNetworksNext already relies on are now exported. The docs gain a User Interface page (the stable index, tensor, constructor, algebra, and broadcasting API, organized by topic) and a Developer Interface page (the named-array types and operations for implementing a tensor type, plus the experimental operator API), alongside the auto-generated Reference. Also addsaligneddims, the view counterpart ofaligndims, and drops the unusedto_indsfrom the public list.Bumps the version to 0.8.4.