Skip to content
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
wants to merge 8 commits into
base: main
Choose a base branch
from

Commits on Feb 6, 2024

  1. 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.
    Minivera committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    a464f02 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    d20f033 View commit details
    Browse the repository at this point in the history

Commits on Feb 7, 2024

  1. Fix small merge issues

    Minivera committed Feb 7, 2024
    Configuration menu
    Copy the full SHA
    9547464 View commit details
    Browse the repository at this point in the history

Commits on Feb 14, 2024

  1. Configuration menu
    Copy the full SHA
    efc1084 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a56f213 View commit details
    Browse the repository at this point in the history
  3. Fix ineffassign issue

    Minivera committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    e934e92 View commit details
    Browse the repository at this point in the history

Commits on Feb 16, 2024

  1. Configuration menu
    Copy the full SHA
    853b56d View commit details
    Browse the repository at this point in the history

Commits on Feb 28, 2024

  1. Configuration menu
    Copy the full SHA
    16f384c View commit details
    Browse the repository at this point in the history