From 87b9bd302a7b7d3509e3d09ef5f1e206f406fe9e Mon Sep 17 00:00:00 2001
From: Preetha Appan <460133+preetapan@users.noreply.github.com>
Date: Mon, 5 Aug 2019 15:00:53 -0500
Subject: [PATCH] Add more comments to clarify job.Stable field

---
 nomad/structs/structs.go | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/nomad/structs/structs.go b/nomad/structs/structs.go
index 59851fcf9..4d19f0690 100644
--- a/nomad/structs/structs.go
+++ b/nomad/structs/structs.go
@@ -3313,7 +3313,10 @@ type Job struct {
 
 	// Stable marks a job as stable. Stability is only defined on "service" and
 	// "system" jobs. The stability of a job will be set automatically as part
-	// of a deployment and can be manually set via APIs.
+	// of a deployment and can be manually set via APIs. This field is updated
+	// when the status of a corresponding deployment transitions to Failed
+	// or Successful. This field is not meaningful for jobs that don't have an
+	// update stanza.
 	Stable bool
 
 	// Version is a monotonically increasing version number that is incremented