Update file.directory clean=True docs #61576
Merged
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.
What does this PR do?
Update the docs for
clean=True
when using file.directoryWhat issues does this PR fix or reference?
Fixes: #26605
Previous Behavior
The documentation was ambiguous about exactly what was meant by
clean=True
and ignore and requireNew Behavior
It's unambiguous, with actual examples clarifying what is supported and unsupported
Merge requirements satisfied?
- [ ] Changelog - https://docs.saltproject.io/en/master/topics/development/changelog.html- [ ] Tests written/updated(docs only change)
Commits signed with GPG?
Yes