Skip to content

Commit 6808a07

Browse files
authored
Merge pull request #43 from smoeding/fix/doc-formatting
Fix a typo and some formatting in the type and provider docs
2 parents dce30ae + 5a3136b commit 6808a07

File tree

4 files changed

+27
-27
lines changed

4 files changed

+27
-27
lines changed

lib/puppet/provider/package/tdnf.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
desc "Support via `tdnf`.
55
66
This provider supports the `install_options` attribute, which allows command-line flags to be passed to tdnf.
7-
These options should be spcified as a string (e.g. '--flag'), a hash (e.g. {'--flag' => 'value'}), or an
7+
These options should be specified as a string (e.g. `'--flag'`), a hash (e.g. `{'--flag' => 'value'}`), or an
88
array where each element is either a string or a hash."
99

1010
has_feature :install_options, :versionable, :virtual_packages

lib/puppet/type/package.rb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -291,15 +291,15 @@ def self.parameters_to_include
291291
desc <<-EOT
292292
The targeted command to use when managing a package:
293293
294-
package { 'mysql':
295-
provider => gem,
296-
}
294+
package { 'mysql':
295+
provider => gem,
296+
}
297297
298-
package { 'mysql-opt':
299-
name => 'mysql',
300-
provider => gem,
301-
command => '/opt/ruby/bin/gem',
302-
}
298+
package { 'mysql-opt':
299+
name => 'mysql',
300+
provider => gem,
301+
command => '/opt/ruby/bin/gem',
302+
}
303303
304304
Each provider defines a package management command and uses the first
305305
instance of the command found in the PATH.

references/type.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2063,15 +2063,15 @@ _(**Namevar:** If omitted, this attribute's value defaults to the resource's tit
20632063

20642064
The targeted command to use when managing a package:
20652065

2066-
package { 'mysql':
2067-
provider => gem,
2068-
}
2066+
package { 'mysql':
2067+
provider => gem,
2068+
}
20692069

2070-
package { 'mysql-opt':
2071-
name => 'mysql',
2072-
provider => gem,
2073-
command => '/opt/ruby/bin/gem',
2074-
}
2070+
package { 'mysql-opt':
2071+
name => 'mysql',
2072+
provider => gem,
2073+
command => '/opt/ruby/bin/gem',
2074+
}
20752075

20762076
Each provider defines a package management command and uses the first
20772077
instance of the command found in the PATH.
@@ -2795,7 +2795,7 @@ has not actually been tested.
27952795
Support via `tdnf`.
27962796

27972797
This provider supports the `install_options` attribute, which allows command-line flags to be passed to tdnf.
2798-
These options should be spcified as a string (e.g. '--flag'), a hash (e.g. {'--flag' => 'value'}), or an
2798+
These options should be specified as a string (e.g. `'--flag'`), a hash (e.g. `{'--flag' => 'value'}`), or an
27992799
array where each element is either a string or a hash.
28002800

28012801
* Required binaries: `rpm`, `tdnf`.

references/types/package.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ _(**Namevar:** If omitted, this attribute's value defaults to the resource's tit
8080

8181
The targeted command to use when managing a package:
8282

83-
package { 'mysql':
84-
provider => gem,
85-
}
83+
package { 'mysql':
84+
provider => gem,
85+
}
8686

87-
package { 'mysql-opt':
88-
name => 'mysql',
89-
provider => gem,
90-
command => '/opt/ruby/bin/gem',
91-
}
87+
package { 'mysql-opt':
88+
name => 'mysql',
89+
provider => gem,
90+
command => '/opt/ruby/bin/gem',
91+
}
9292

9393
Each provider defines a package management command and uses the first
9494
instance of the command found in the PATH.
@@ -942,7 +942,7 @@ has not actually been tested.
942942
Support via `tdnf`.
943943

944944
This provider supports the `install_options` attribute, which allows command-line flags to be passed to tdnf.
945-
These options should be spcified as a string (e.g. '--flag'), a hash (e.g. {'--flag' => 'value'}), or an
945+
These options should be specified as a string (e.g. `'--flag'`), a hash (e.g. `{'--flag' => 'value'}`), or an
946946
array where each element is either a string or a hash.
947947

948948
* Required binaries: `rpm`, `tdnf`

0 commit comments

Comments
 (0)