Issue #15114 has been updated by Andrew  Parker.

The referenced page states 
(<https://sites.google.com/a/puppetlabs.com/ux/investigations/error-messages?pli=1>):
 


# Error messages

What makes a good error message?

Most importantly, error messages should be thought of as, "How to fix it" 
messages.  These are other qualities a good error message should have.

* Clear:  clearly state as early as possible that an error has been encountered.
* Responsive:  tell the customer what the software tried to do.
* Actionable:  suggest another course of action.
* User perspective:  written from the perspective of the customer, not the 
developer.  
* Minimal:  as few words as possible to communicate the essential information.
* Courteous:  don't condemn the customer, mock them, or taunt them, even if 
what they're doing is really silly.
* Well-formed:  use existing code paths and their standard formatting to draw 
attention to an error message, rather than inventing a new style.

----------------------------------------
Refactor #15114: RValue function errors should be more clear
https://projects.puppetlabs.com/issues/15114#change-71681

Author: Hunter Haugen
Status: Accepted
Priority: Normal
Assignee: Hunter Haugen
Category: 
Target version: 
Affected Puppet version: 
Keywords: ux, functions
Branch: 


When using an `:rvalue` function that isn't assigned to a variable in Puppet 
DSL, this error is shown:

`Function 'hiera_create_resources' must be the value of a statement at 
/opt/puppet/mastertest/manifests/nodes.pp:21 on node foo.com`

Something that might be more clear would be:

`Function 'hiera_create_resources' is an rvalue function and must be assigned 
to a variable at /opt/puppet/mastertest/manifests/nodes.pp:21 on node foo.com`

Or something to indicate that variable assignment is needed for the function, 
and perhaps its type.


-- 
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-bugs?hl=en.

Reply via email to