Add puppet-strings docs - #64
Conversation
| # | ||
| # It shouldn't be necessary to directly include this class. | ||
| # | ||
| # @summary Common PAM requirements for googleauthenticator. |
There was a problem hiding this comment.
Should this be marked private?
There was a problem hiding this comment.
I'm only marking classes as private which use assert_private() because I think it's better to enforce it instead of only marking it private in the documentation.
| # } | ||
| # | ||
| # @summary Setup a PAM module to use Google-authenticator. | ||
| # @param mode Optionally, set the mode to use. 'root-only' or 'all-users' are supported right now. |
There was a problem hiding this comment.
There was a problem hiding this comment.
That link didn't work out 🙈 Not sure what you're pointing at.
There was a problem hiding this comment.
oh... Not too sure. How does it relate to
???There was a problem hiding this comment.
tbh, I have no idea. I've just converted the documentation to puppet-strings. If I google for Google Authenticator setup (e.g. https://wiki.archlinux.org/index.php/Google_Authenticator) I can't even figure out where this mode parameter is going to.
| # | ||
| # @summary Setup a PAM module for Google-authenticator on RedHat/CentOS. | ||
| # @param mode Set the mode to use ('root-only', 'all-users' and 'systemwide-users' are supported right now). | ||
| # @param ensure present/absent |
There was a problem hiding this comment.
Better to add an Enum data type?
There was a problem hiding this comment.
Sure, there is only more stuff to refactor. But I prefer to keep changes minimal because it makes it easier to review and trace back in cases of problems.
| # | ||
| # Common class for googleauthenticator::user::systemwide | ||
| # | ||
| # @summary Common class for googleauthenticator::user::systemwide |
There was a problem hiding this comment.
As said above :) I prefer to keep it sync with assert_private().
alexjfisher
left a comment
alexjfisher
left a comment
There was a problem hiding this comment.
Thanks for working on so many modules. Mostly they're looking great. Just a few comments in this one, (and some of the comments I've made in other PRs I might not have called out here explicitly).
917b8f1 to
7aa702c
Compare
|
Dear @baurmatt, thanks for the PR! This is Vox Pupuli Tasks, your friendly Vox Pupuli GitHub Bot. I noticed that your pull request contains merge conflict. Can you please rebase? You can find my sourcecode at voxpupuli/vox-pupuli-tasks |
2 participants
Pull Request (PR) description
This Pull Request (PR) fixes the following issues