docs: add examples of ImageExt usage and cover GenericImage
#747
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
✅ Deploy Preview for testcontainers-rust ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
I struggled a bit when upgrading to testcontainers-rs 0.23, since the interfaces had changed somewhat since the last version I used. The documentation didn't explain exactly how to use the methods in `ImageExt` in conjunction with those of `GenericImage`. This change adds a bit more content to the documentation: * A few more lines in the README file to exercise the configuration methods in `ImageExt`, * Some documentation for `GenericImage` showing how it is used along with `ImageExt`. The latter in particular includes a doctest. If the API is changed in the future so that further changes are needed, the doctest will fail and can be updated accordingly. This will make it easier for downstream users to understand how to port their code.
|
Thank you for the contribution! 🙏 We actually had a migration guide as part of 0.18, there were big changes: https://github.com/testcontainers/testcontainers-rs/releases/tag/0.18.0 But that's definitely not obvious place when we have several versions ahead. |
DDtKey
changed the title
ImageExt usage and cover GenericImage
DDtKey
approved these changes
Oct 15, 2024
|
Thanks for the quick approval! It seems that the PR can't be merged yet due to some flakiness in the tests. I also don't see a way to retry the affected actions. Could you re-trigger them? Thank you. |
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.
I struggled a bit when upgrading to testcontainers-rs 0.23, since the interfaces had changed somewhat since the last version I used. The documentation didn't explain exactly how to use the methods in
ImageExtin conjunction with those ofGenericImage.This change adds a bit more content to the documentation:
ImageExt,GenericImageshowing how it is used along withImageExt.The latter in particular includes a doctest. If the API is changed in the future so that further changes are needed, the doctest will fail and can be updated accordingly. This will make it easier for downstream users to understand how to port their code.