Issue #20170 has been updated by Rob Nelson.

Status changed from Unreviewed to Needs Decision

This needs a decision by the product owner. Embedding the default value in the 
description could cause a discrepancy with the actual defaultto value, but 
would require updating many descriptions throughout the codebase.

----------------------------------------
Feature #20170: puppet describe <type> should list `defaultto` values
https://projects.puppetlabs.com/issues/20170#change-98378

* Author: Joshua Hoblitt
* Status: Needs Decision
* Priority: Low
* Assignee: 
* Category: documentation
* Target version: 
* Affected Puppet version: 3.1.1
* Keywords: 
* Branch: 
----------------------------------------
`puppet describe` conveniently includes the newvalues() symbols for a type 
param/property in it's output.  It would also be nice if the same was done for 
default values set with defaultto().  It appears that this is the case but at 
least as of puppet 3.1.1, the default value information is actually encoded in 
the param/property's desc string.

$ puppet describe user | grep -A3 '\*\*system\*\*'
- **system**
    Whether the user is a system user, according to the OS's criteria;
    on most platforms, a UID less than or equal to 500 indicates a system
    user. Defaults to `false`.  Valid values are `true`, `false`.


>From puppet 3.1.1's lib/puppet/type/user.rb

    newparam(:system, :boolean => true) do
      desc "Whether the user is a system user, according to the OS's criteria;
      on most platforms, a UID less than or equal to 500 indicates a system
      user. Defaults to `false`."

      newvalues(:true, :false)

      defaultto false
    end



-- 
You have received this notification because you have either subscribed to it, 
or are involved in it.
To change your notification preferences, please click here: 
http://projects.puppetlabs.com/my/account

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at http://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to