[puppetmaster] Improve API docs around naming of stories and mods.
TEST=none
MF-104 #comment [puppetmaster] Improve API docs around naming of stories and mods.
MF-104 #done
Change-Id: Ic3df1b7265f0f0aaaefb2caff27e9bbf9ed65a11
diff --git a/public/fidl/fuchsia.modular/story/puppet_master.fidl b/public/fidl/fuchsia.modular/story/puppet_master.fidl
index ed7bbb4..dfb7138 100644
--- a/public/fidl/fuchsia.modular/story/puppet_master.fidl
+++ b/public/fidl/fuchsia.modular/story/puppet_master.fidl
@@ -45,7 +45,9 @@
// shells (session and story shells).
[Discoverable]
interface PuppetMaster {
- // Requests a capability to control a story by name.
+ // Requests a capability to control a story by name. The name acts as the
+ // story's unique ID. Calling ControlStory() for the same story name will
+ // control the same story.
//
// The story name, as well as modification to the story, are durable and
// persist across device reboots. This allows the client to assign its own
diff --git a/public/fidl/fuchsia.modular/story/story_command.fidl b/public/fidl/fuchsia.modular/story/story_command.fidl
index 19a6c86..448da41 100644
--- a/public/fidl/fuchsia.modular/story/story_command.fidl
+++ b/public/fidl/fuchsia.modular/story/story_command.fidl
@@ -44,11 +44,12 @@
// Adds a mod described by |intent| to the story with name |mod_name|. If
// |mod_name| already exists in the story, the mod is updated.
struct AddMod {
- // The name of the mod within the story. Since AddMod is reused for
- // observation and mod names are vector<string> inside the framework, they
- // are vector<string> here as well.
+ // The name of the mod within the story. The mod's name acts as the unique
+ // ID of the mod, scoped to the story in which it is contained. Since
+ // AddMod is reused for observation and mod names are vector<string>
+ // inside the framework, they are vector<string> here as well.
//
- // Clients should treat the full vector as a single mod name.
+ // Clients should treat the full vector as a single opaque value.
vector<string> mod_name;
Intent intent;
