Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings

[Nicholas Fagerlund (JIRA)]

Title: Message Title

Nicholas Fagerlund created an issue   Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Issue Type: Bug Assignee: Unassigned Created: 2016/10/11 11:24 AM Priority: Normal Reporter: Nicholas Fagerlund In Strings's JSON output, check out the 'password' parameter of the 'user' resource type. It has a leftover %q (plus curly braces) from its original ruby string quoting: { "name": "password", "description": "%q{The user's password, in whatever encrypted format the local system\nrequires. Consult your operating system's documentation for acceptable password\nencryption formats and requirements.\n\n* Mac OS X 10.5 and 10.6, and some older Linux distributions, use salted SHA1\n hashes. You can use Puppet's built-in `sha1` function to generate a salted SHA1\n hash from a password.\n* Mac OS X 10.7 (Lion), and many recent Linux distributions, use salted SHA512\n hashes. The Puppet Labs [stdlib][] module contains a `str2saltedsha512` function\n which can generate password hashes for these operating systems.\n* OS X 10.8 and higher use salted SHA512 PBKDF2 hashes. When managing passwords\n on these systems, the `salt` and `iterations` attributes need to be specified as\n well as the password.\n* Windows passwords can only be managed in cleartext, as there is no Windows API\n for setting the password hash.\n\n[stdlib]: https://github.com/puppetlabs/puppetlabs-stdlib/\n\nEnclose any value that includes a dollar sign ($) in single quotes (') to avoid\naccidental variable interpolation.}" } Either Strings should be stripping this, or, if that's not feasible, we should specify which quoting constructs are legal to use in a resource type / provider / etc. Add Comment   This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- 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 https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.