MemoryStory doc tweaks

doc/status.rst

@@ -23,6 +23,7 @@ Planned
 
 * write quickstart documentation
 * python client: add docs
+* add API support for returning a single AppSummary or HostSummary
 * test go get & convert to github import paths
 * experiment with cross-compiling windows/linux
 * Setup build system
@@ -48,14 +49,12 @@ Possible
   * summary --> versions/&with?parameters
 
 * add overview API
-* add ``count`` field to host summary results?
 * add ``app`` and ``host`` version summaries with counts of each version
 * gzip responses when possible
 * Add paging to REST results
 * add ``since`` query parameter, which only returns newer ``version`` entries
-* store and return app_data with each Version, allowing custom data
+* store and return app_data with each Version, allowing custom application data
 * Store more historical data from updates.
 
   * Last update time for each app/version/machine. This would give a full version history for each machine.
 
-* Store application specific state information.

memstore/example_test.go

@@ -10,16 +10,24 @@ func init() {
 	s = memstore.NewMemoryStore()
 }
 
-func ExampleMemoryStore_Versions() {
+func ExampleMemoryStore_Versions_all() {
 	// returns all known Version structs
 	vers := s.Versions("", "", "")
 	for v := range vers {
 		fmt.Println(v)
 	}
 }
 
+func ExampleMemoryStore_Versions_appId() {
+	// returns all known Version structs for a specific AppId
+	vers := s.Versions("app1", "", "")
+	for v := range vers {
+		fmt.Println(v)
+	}
+}
+
 func ExampleMemoryStore_Update() {
-	v := version.Version{App: "app", Ver: "1.2.3", Host: "example.com"}
+	v := version.Version{App: "app1", Ver: "1.2.3", Host: "host1.example.com"}
 	err := s.Update(v)
 	if err != nil {
 		// handle error

memstore/memstore.go

@@ -29,6 +29,8 @@ func NewMemoryStore() (m *MemoryStore) {
 }
 
 // App returns an AppSummary for the given AppId.
+// The value of ok follows map indexing conventions: true if AppId is present,
+// false otherwise.
 func (s *MemoryStore) App(AppId string) (as version.AppSummary, ok bool) {
 	as, ok = s.app[AppId]
 	return
@@ -44,6 +46,8 @@ func (s *MemoryStore) Apps() []version.AppSummary {
 }
 
 // Host returns a HostSummary for the given Host.
+// The value of ok follows map indexing conventions: true if Host is present,
+// false otherwise.
 func (s *MemoryStore) Host(Host string) (hs version.HostSummary, ok bool) {
 	hs, ok = s.host[Host]
 	return