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

[Enhancement]: Docs reference removed logging API #1242

Closed
jwm01cg opened this issue Aug 28, 2024 · 3 comments
Closed

[Enhancement]: Docs reference removed logging API #1242

jwm01cg opened this issue Aug 28, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@jwm01cg
Copy link

jwm01cg commented Aug 28, 2024

Problem

The documentation for custom configuration at https://dotnet.testcontainers.org/custom_configuration/#enable-logging references the TestContainersSettings.Logger API which was obsoleted in #1100 and removed in #1146.

Solution

The docs should be updated to reference the new AbstractBuilder.WithLogger API.

Benefit

Avoids confusion when configuring logging.

Alternatives

No

Would you like to help contributing this enhancement?

Yes

@jwm01cg jwm01cg added the enhancement New feature or request label Aug 28, 2024
@jwm01cg
Copy link
Author

jwm01cg commented Aug 28, 2024

BTW, I held off opening a PR because I can see the former pull request references something about built-in integration with XUnit, so I'm not sure what kind of configuration, if any, is recommended now.

@HofmeisterAn
Copy link
Collaborator

Yes, the documentation is outdated, as mentioned here: #1215 (comment). I have updated the documentation along with #1235 (1, 2). The documentation should be up-to-date soon. If you don’t mind, I will close this issue as a duplicate.

Regarding xUnit.net, we will update the documentation again once the package is available. This update will address creating the logger for the test output helper and message sink.

@jwm01cg
Copy link
Author

jwm01cg commented Aug 28, 2024

Ah, sorry for missing that duplicate issue. Happy for you to close this.

@HofmeisterAn HofmeisterAn closed this as not planned Won't fix, can't repro, duplicate, stale Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants