Allow zero purge_interval to disable recorder purge #4591
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
ludeeus
reviewed
Feb 10, 2018
source/_components/recorder.markdown
Outdated
| @@ -40,7 +40,7 @@ recorder: | |||
| required: false | |||
| type: int | |||
| purge_interval: | |||
| description: How often (in days) the purge task runs. If a scheduled purge is missed (e.g., if Home Assistant was not running), the schedule will resume soon after Home Assistant restarts. You can use the [service](#service-purge) call `purge` when required without impacting the purge schedule. | |||
| description: How often (in days) the purge task runs. If a scheduled purge is missed (e.g., if Home Assistant was not running), the schedule will resume soon after Home Assistant restarts. You can use the [service](#service-purge) call `purge` when required without impacting the purge schedule. If this is set to zero, purging is disabled. | |||
There was a problem hiding this comment.
That field expect an numeric value, wouldn't If this is set to 0, purging is disabled. be more descriptive?
There was a problem hiding this comment.
Thanks. I am not sure, so now I changed it to include both options :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
Pull request in home-assistant (if applicable): home-assistant/core#12220
Checklist:
current. New documentation for platforms/components and features should go tonext.