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

Fully document that @TempDir can be used on constructor parameters #4285

Closed
sbrannen opened this issue Jan 28, 2025 · 3 comments
Closed

Fully document that @TempDir can be used on constructor parameters #4285

sbrannen opened this issue Jan 28, 2025 · 3 comments

Comments

@sbrannen
Copy link
Member

sbrannen commented Jan 28, 2025

Overview

As a followup to #4060, we need to update the Javadoc and the Annotations section of the User Guide to mention that @TempDir can be used not only on fields and lifecycle/test method parameters but also on test class constructor parameters.

Related Issues

@marcphilipp
Copy link
Member

According to the changes in #4060 it's already documented. Did I miss a spot?

@sbrannen
Copy link
Member Author

sbrannen commented Jan 29, 2025

According to the changes in #4060 it's already documented. Did I miss a spot?

The Javadoc has not been updated yet, and although 99% of the User Guide has been updated, the Annotations overview section has not yet been updated.

I originally noticed it in the Javadoc, and quick search in the User Guide led me to believe that it hadn't been done in the User Guide either. So I created this issue to make sure we didn't forget about those spots (because I couldn't reopen the PR).

I just updated this issue's title and description to reflect that.

@sbrannen sbrannen changed the title Document that @TempDir can be used on constructor parameters Fully document that @TempDir can be used on constructor parameters Jan 29, 2025
@sbrannen sbrannen self-assigned this Jan 29, 2025
@marcphilipp
Copy link
Member

Thanks! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants