docs: add some explanation of what Skipped should mean

Sponsored-by: author

1 files changed, 9 insertions, 0 deletions

diff --git a/src/policy.rs b/src/policy.rs
index 9b66c1d..7241f0f 100644
--- a/src/policy.rs
+++ b/src/policy.rs
@@ -6,6 +6,15 @@ use crate::generation::LocalGeneration;
 use log::{debug, warn};
 
 /// Policy for what gets backed up.
+///
+/// The policy allows two aspects to be controlled:
+///
+/// * should new files )(files that didn't exist in the previous
+///   backup be included in the new backup?
+/// * should files that haven't been changed since the previous backup
+///   be included in the new backup?
+///
+/// If policy doesn't allow a file to be included, it's skipped.
 pub struct BackupPolicy {
     new: bool,
     old_if_changed: bool,