Update adaptor documentation #156
Merged
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
* Make sure each adaptor has at least a minimal explanation of what it does * For each function, add a table detailing which concepts the returned adaptor supports and under what circumstances * Add a bit of introductory blurb explaining about argument passing and warning about using flux::ref There's still more to do - many of the adaptors still need usage examples, "see also" links and other things, but this is better than it was.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #156 +/- ##
=======================================
Coverage 97.99% 97.99%
=======================================
Files 66 66
Lines 2392 2392
=======================================
Hits 2344 2344
Misses 48 48 ☔ View full report in Codecov by Sentry. |
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.
There's still more to do - many of the adaptors still need usage examples, "see also" links and other things, but this is better than it was.