(maint) Fix documentation for include_system_store

smortex · smortex · commit 92b8d3a963be · 2022-02-23T22:34:30.000-10:00
This is an option that must be set in the options: hash, not passed
directly to #get.
diff --git a/lib/puppet/http/client.rb b/lib/puppet/http/client.rb
@@ -19,7 +19,7 @@
 #   response = client.get(URI("http://www.example.com"))
 #
 # @example To make an HTTPS GET request, trusting the puppet CA and certs in Puppet's CA bundle:
-#   response = client.get(URI("https://www.example.com"), include_system_store: true)
+#   response = client.get(URI("https://www.example.com"), options: { include_system_store: true })
 #
 # @example To use a URL containing special characters, such as spaces:
 #  response = client.get(URI(Puppet::Util.uri_encode("https://www.example.com/path to file")))

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`# response = client.get(URI("http://www.example.com"))`
`20`	`20`	`#`
`21`	`21`	`# @example To make an HTTPS GET request, trusting the puppet CA and certs in Puppet's CA bundle:`
`22`		`-# response = client.get(URI("https://www.example.com"), include_system_store: true)`
	`22`	`+# response = client.get(URI("https://www.example.com"), options: { include_system_store: true })`
`23`	`23`	`#`
`24`	`24`	`# @example To use a URL containing special characters, such as spaces:`
`25`	`25`	`# response = client.get(URI(Puppet::Util.uri_encode("https://www.example.com/path to file")))`