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

JavaDoc of TemperaryFolder: folder not guaranteed to be deleted #1021

Merged
merged 1 commit into from
Nov 7, 2014

Conversation

UrsMetz
Copy link
Contributor

@UrsMetz UrsMetz commented Nov 5, 2014

This adjusts the JavaDoc of TemporaryFolder to make it clear that the folders created by the rule are not guaranteed to be deleted after the test finishes, cf. discussion in #1001 and #616.

* The TemporaryFolder Rule allows creation of files and folders that should
* be deleted when the test method finishes (whether it passes or
* fails). Whether the deletion is successful or not is not checked by this rule.
* No exception will be thrown in case the deletion fails:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nits:

  • end sentence with a period
  • blank line (only a *) on the next line
  • following line should be <p>Example of usage:

@kcooney
Copy link
Member

kcooney commented Nov 6, 2014

Thanks!

@UrsMetz
Copy link
Contributor Author

UrsMetz commented Nov 6, 2014

@kcooney I fixed the issues you pointed out, please have a look.
Should I squash the two commits when everything is fine?

@marcphilipp
Copy link
Member

LGTM!

Please squash your commits. :-)

@UrsMetz UrsMetz force-pushed the adjust-temporary-folder-javadoc branch from 999d8d1 to b277169 Compare November 6, 2014 18:56
@UrsMetz UrsMetz force-pushed the adjust-temporary-folder-javadoc branch from b277169 to 93b08bc Compare November 6, 2014 19:00
@UrsMetz
Copy link
Contributor Author

UrsMetz commented Nov 6, 2014

@marcphilipp Done :-)

kcooney added a commit that referenced this pull request Nov 7, 2014
JavaDoc of TemperaryFolder: folder not guaranteed to be deleted
@kcooney kcooney merged commit d20ea40 into junit-team:master Nov 7, 2014
@marcphilipp
Copy link
Member

@UrsMetz Thanks!

@stefanbirkner stefanbirkner added this to the 4.12 milestone Nov 7, 2014
@UrsMetz UrsMetz deleted the adjust-temporary-folder-javadoc branch November 7, 2014 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants