Add detailed rustdoc to reftests #1232
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
Signed-off-by: Daniel Carl Jones <[email protected]>
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
c-hagem
approved these changes
Jan 15, 2025
I think that sounds good, although I don't necessarily have time to spend on digging deeper there. Would you mind leaving it for a future PR (which you may be able to introduce)? |
keremnc
pushed a commit
to keremnc/mountpoint-s3
that referenced
this pull request
Jan 24, 2025
The reference tests for Mountpoint can be quite complex, especially for those unfamiliar both with the tests themselves or the idea of reference-based testing. This change adds more detailed rustdoc with the goal to ramp up new readers with the reftests, give an overview of what the tests are doing, and point the reader to resources for learning more. ### Does this change impact existing behavior? No, all code documentation changes. ### Does this change need a changelog entry? Does it require a version change? No, code doc changes only. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). Signed-off-by: Daniel Carl Jones <[email protected]>
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.
The reference tests for Mountpoint can be quite complex, especially for those unfamiliar both with the tests themselves or the idea of reference-based testing.
This change adds more detailed rustdoc with the goal to ramp up new readers with the reftests, give an overview of what the tests are doing, and point the reader to resources for learning more.
Does this change impact existing behavior?
No, all code documentation changes.
Does this change need a changelog entry? Does it require a version change?
No, code doc changes only.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).