README.md in puppet-lint-params_empty_string-check-0.1.0 vs README.md in puppet-lint-params_empty_string-check-1.0.0
- old
+ new
@@ -37,26 +37,32 @@
#### What you have done
```puppet
class foo (
String $bar = '',
+ String[0] $foo = '',
+ Variant[String[0], Integer] $baz = '',
) {
# logic
}
```
+All three of the above variantions aren't recommended.
+
#### What you should have done
```puppet
class foo (
Optional[String[1]] $bar = undef,
+ Optional[String[1]] $foo = undef,
+ Optional[String[1]] $baz = undef,
) {
# logic
}
```
-There are situations where `undef` doesn't make sense your you don't want a
+There are situations where `undef` doesn't make sense or you don't want a
minimal string length of 1. Because of that, this module doesn't implement a
autofix method.
#### Disabling the check
@@ -70,18 +76,27 @@
```ruby
PuppetLint.configuration.send('disable_empty_string_assignment')
```
+You can also disable it inline:
+
+```puppet
+class foo (
+ String $baz = '', # lint:ignore:params_empty_string_assignment
+) {
+ # awesome logic here
+}
+```
+
## Transfer Notice
This plugin was originally authored by [Tim 'bastelfreak' Meusel](https://github.com/bastelfreak).
-The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
-Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Camptocamp.
+The maintainer preferred that Vox Pupuli take ownership of the module for future improvement and maintenance.
## License
-This gem is licensed under the Apache-2 license.
+This gem is licensed under the AGPL-3 license.
## Release information
To make a new release, please do:
* update the version in the gemspec file