improve documentation wording

Author: piceri

README.md

@@ -186,8 +186,9 @@ The metrics exposed beyond the default Prometheus metrics are:
   record uploads.
 * `deptracker_post_record_rate_limited`: the number of post attempts
   that were rate limited.
-* `deptracker_post_record_no_attestation`: the number of successful
-  posts for container digest with no matching attestation for the org.
+* `deptracker_post_record_no_attestation`: the number of attempts
+  that resulted in no matching attestation for the container digest
+  (404 "no artifacts found" responses).
 * `deptracker_post_record_soft_fail`: the number of recoverable failed
   attempts to upload the deployment record.
 * `deptracker_post_record_hard_fail`: the number of failures to

pkg/deploymentrecord/client.go

@@ -160,7 +160,7 @@ func (c *ClientError) Unwrap() error {
 	return c.err
 }
 
-// NoArtifactError represents a 404 client response where no artifact was found.
+// NoArtifactError represents a 404 client response whose body indicates "no artifacts found".
 type NoArtifactError struct {
 	err error
 }

pkg/dtmetrics/prom.go

@@ -53,15 +53,15 @@ var (
 	PostDeploymentRecordNoAttestation = promauto.NewCounter(
 		prometheus.CounterOpts{
 			Name: "deptracker_post_record_no_attestation",
-			Help: "The total number of successful posts for container digest with no matching attestation for the org",
+			Help: "The total number of post attempts that resulted in no matching attestation for the container digest (404 'no artifacts found' responses)",
 		},
 	)
 
 	//nolint: revive
 	PostDeploymentRecordRateLimited = promauto.NewCounter(
 		prometheus.CounterOpts{
 			Name: "deptracker_post_record_rate_limited",
-			Help: "The total number of post failures due to rate limits",
+			Help: "The total number of post attempts that were rate limited",
 		},
 	)