From 5f5fb51eaee7e45b6fc4216192f471d8d04ed55a Mon Sep 17 00:00:00 2001 From: Lucien Greathouse Date: Tue, 1 Oct 2019 10:32:05 -0700 Subject: [PATCH] Make up terminology for 'instigating path' in instance metadata --- src/snapshot/metadata.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/snapshot/metadata.rs b/src/snapshot/metadata.rs index f4c4f241..62ef7fb8 100644 --- a/src/snapshot/metadata.rs +++ b/src/snapshot/metadata.rs @@ -18,12 +18,15 @@ pub struct InstanceMetadata { /// even if they don't exist, since the presence of a file can change the /// outcome of a snapshot function. /// + /// The first path in this list is considered the "instigating path", and + /// will be the snapshot target if any of the contributing paths change. + /// /// For example, a file named foo.lua might have these contributing paths: - /// - foo.lua + /// - foo.lua (instigating path) /// - foo.meta.json (even if this file doesn't exist!) /// /// A directory named bar/ included in the project file might have these: - /// - bar/ + /// - bar/ (instigating path) /// - bar/init.meta.json /// - bar/init.lua /// - bar/init.server.lua