New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Use the testcontainers_test
package for root tests to improve documentation
#2202
Draft
Minivera
wants to merge
8
commits into
testcontainers:main
Choose a base branch
from
Minivera:gui/test-packages-for-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+902
−799
Commits on Feb 6, 2024
-
Introduce a
testcontainers_test
package to solve some of the docs i……mports As discussed in testcontainers#2180, the imported examples from tests for the docs from lack the package prefix before the imports, which leads to the example not being directly copy/paste-able. To solve the issue it was suggested to create a `testcontainers_test` package for the example tests and to convert everything. I did my best to convert all the tests in a way that makes sense, and I extracted any test that would import very internal things that we should not export. Some of the tests had to be slightly rewritten (the lifecycle tests in particular), but they should stay pretty much the same. Test by running all the root unit tests, they should all work as expected. The examples in the docs should all have the packages as prefixes now.
Configuration menu - View commit details
-
Copy full SHA for a464f02 - Browse repository at this point
Copy the full SHA a464f02View commit details -
Configuration menu - View commit details
-
Copy full SHA for d20f033 - Browse repository at this point
Copy the full SHA d20f033View commit details
Commits on Feb 7, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 9547464 - Browse repository at this point
Copy the full SHA 9547464View commit details
Commits on Feb 14, 2024
-
Configuration menu - View commit details
-
Copy full SHA for efc1084 - Browse repository at this point
Copy the full SHA efc1084View commit details -
Configuration menu - View commit details
-
Copy full SHA for a56f213 - Browse repository at this point
Copy the full SHA a56f213View commit details -
Configuration menu - View commit details
-
Copy full SHA for e934e92 - Browse repository at this point
Copy the full SHA e934e92View commit details
Commits on Feb 16, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 853b56d - Browse repository at this point
Copy the full SHA 853b56dView commit details
Commits on Feb 28, 2024
-
Configuration menu - View commit details
-
Copy full SHA for 16f384c - Browse repository at this point
Copy the full SHA 16f384cView commit details
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.