[MLDM-66] Package documentation #10360
Merged
Conversation
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
size-limit report 📦
|
…ckage-documentation
Base automatically changed from
rau/mldm-66-variable-documentation
to
master
September 26, 2024 16:20
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #10360 +/- ##
==========================================
+ Coverage 62.17% 62.20% +0.02%
==========================================
Files 1219 1219
Lines 87664 87663 -1
Branches 1820 1820
==========================================
+ Hits 54507 54532 +25
+ Misses 32316 32292 -24
+ Partials 841 839 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
jrockway
approved these changes
Sep 26, 2024
| // Package client implements a gRPC client for Pachyderm. | ||
| // | ||
| // Before using this package, give serious thought to just using the generated | ||
| // gRPC interface directly. |
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 adds a check for the presence of package documentation, and adds minimal documentation throughout.
In the interest of time, in most cases that documentation is little more than “Package foo needs to be documented,” but I did try to come up with something slightly better when I could.