Fix sample code in documentation to be Ruby instead of Go

brandur · brandur · commit eefc8849fc09 · 2024-04-27T21:03:24.000-07:00
Fixes some sample code on the defaults for `#by_state` so that it's Ruby
code instead of Go. It was Go because it'd been copy/pasta'ed from an
original Go docblock.
diff --git a/lib/insert_opts.rb b/lib/insert_opts.rb
@@ -112,7 +112,7 @@ class UniqueOpts
     # Unlike other unique options, ByState gets a default when it's not set for
     # user convenience. The default is equivalent to:
     #
-    #   ByState: []rivertype.JobState{rivertype.JobStateAvailable, rivertype.JobStateCompleted, rivertype.JobStateRunning, rivertype.JobStateRetryable, rivertype.JobStateScheduled}
+    #   by_state: [River::JOB_STATE_AVAILABLE, River::JOB_STATE_COMPLETED, River::JOB_STATE_RUNNING, River::JOB_STATE_RETRYABLE, River::JOB_STATE_SCHEDULED]
     #
     # With this setting, any jobs of the same kind that have been completed or
     # discarded, but not yet cleaned out by the system, won't count towards the

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ class UniqueOpts`
`112`	`112`	`# Unlike other unique options, ByState gets a default when it's not set for`
`113`	`113`	`# user convenience. The default is equivalent to:`
`114`	`114`	`#`
`115`		`- # ByState: []rivertype.JobState{rivertype.JobStateAvailable, rivertype.JobStateCompleted, rivertype.JobStateRunning, rivertype.JobStateRetryable, rivertype.JobStateScheduled}`
	`115`	`+ # by_state: [River::JOB_STATE_AVAILABLE, River::JOB_STATE_COMPLETED, River::JOB_STATE_RUNNING, River::JOB_STATE_RETRYABLE, River::JOB_STATE_SCHEDULED]`
`116`	`116`	`#`
`117`	`117`	`# With this setting, any jobs of the same kind that have been completed or`
`118`	`118`	`# discarded, but not yet cleaned out by the system, won't count towards the`