Skip to content

Fix a typo and some formatting in the type and provider docs #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2025
Merged

Fix a typo and some formatting in the type and provider docs #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/puppet/provider/package/tdnf.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
desc "Support via `tdnf`.

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

has_feature :install_options, :versionable, :virtual_packages
Expand Down
16 changes: 8 additions & 8 deletions lib/puppet/type/package.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,15 +291,15 @@ def self.parameters_to_include
desc <<-EOT
The targeted command to use when managing a package:

package { 'mysql':
provider => gem,
}
package { 'mysql':
provider => gem,
}

package { 'mysql-opt':
name => 'mysql',
provider => gem,
command => '/opt/ruby/bin/gem',
}
package { 'mysql-opt':
name => 'mysql',
provider => gem,
command => '/opt/ruby/bin/gem',
}

Each provider defines a package management command and uses the first
instance of the command found in the PATH.
Expand Down
18 changes: 9 additions & 9 deletions references/type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2063,15 +2063,15 @@ _(**Namevar:** If omitted, this attribute's value defaults to the resource's tit

The targeted command to use when managing a package:

package { 'mysql':
provider => gem,
}
package { 'mysql':
provider => gem,
}

package { 'mysql-opt':
name => 'mysql',
provider => gem,
command => '/opt/ruby/bin/gem',
}
package { 'mysql-opt':
name => 'mysql',
provider => gem,
command => '/opt/ruby/bin/gem',
}

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

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

* Required binaries: `rpm`, `tdnf`.
Expand Down
18 changes: 9 additions & 9 deletions references/types/package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ _(**Namevar:** If omitted, this attribute's value defaults to the resource's tit

The targeted command to use when managing a package:

package { 'mysql':
provider => gem,
}
package { 'mysql':
provider => gem,
}

package { 'mysql-opt':
name => 'mysql',
provider => gem,
command => '/opt/ruby/bin/gem',
}
package { 'mysql-opt':
name => 'mysql',
provider => gem,
command => '/opt/ruby/bin/gem',
}

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

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

* Required binaries: `rpm`, `tdnf`
Expand Down