diff options
| author | Tim Smith <tsmith@chef.io> | 2018-08-30 20:41:24 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2018-08-31 17:17:24 -0700 |
| commit | 968b839c2931b8ea02b2732a50b05d65c528f6ef (patch) | |
| tree | 87a22b7626ff54d6198ce3ec5fb134c2183a691e | |
| parent | 90c17184463b41f006622ff0134c2930cddf2653 (diff) | |
| download | chef-968b839c2931b8ea02b2732a50b05d65c528f6ef.tar.gz | |
Sync windows_printer descriptions with the docs site
Docs team cleaned these up and I never trickled them back here.
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | lib/chef/resource/windows_printer.rb | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/lib/chef/resource/windows_printer.rb b/lib/chef/resource/windows_printer.rb index c58e02b994..7d596a9691 100644 --- a/lib/chef/resource/windows_printer.rb +++ b/lib/chef/resource/windows_printer.rb @@ -27,20 +27,18 @@ class Chef resource_name :windows_printer provides(:windows_printer) { true } - description "Use the windows_printer resource to setup Windows printers. Note"\ - " that this doesn't currently install a printer driver. You must"\ - " already have the driver installed on the system." + description "Use the windows_printer resource to setup Windows printers. Note that this doesn't currently install a printer driver. You must already have the driver installed on the system." introduced "14.0" property :device_id, String, - description: "Printer queue name, e.g. 'HP LJ 5200 in fifth floor copy room'.", + description: "Printer queue name, such as 'HP LJ 5200 in fifth floor copy room'.", name_property: true property :comment, String, description: "Optional descriptor for the printer queue." property :default, [TrueClass, FalseClass], - description: "Should this be the system's default printer.", + description: "Determines whether or not this should be the system's default printer.", default: false property :driver_name, String, @@ -48,17 +46,17 @@ class Chef required: true property :location, String, - description: "Printer location, e.g. 'Fifth floor copy room'." + description: "Printer location, such as 'Fifth floor copy room'." property :shared, [TrueClass, FalseClass], - description: "Should the printer be shared.", + description: "Determines whether or not the printer is shared.", default: false property :share_name, String, - description: "The name to share the printer as." + description: "The name used to identify the shared printer." property :ipv4_address, String, - description: "Printer IPv4 address, e.g. '10.4.64.23'.", + description: "The IPv4 address of the printer, such as '10.4.64.23'", validation_message: "The ipv4_address property must be in the IPv4 format of WWW.XXX.YYY.ZZZ", regex: Resolv::IPv4::Regex |