New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ensure all parameters are documented #151
Conversation
Just dropping in real quick to offer an immense THANK YOU for this. Not that things were that bad, but this is pure goodness that's usually not the most fun thing to do. |
Just added REFERENCE.md to the repo… Live preview here: |
This is looking great, thank you @smortex. |
Cool ! This seems fair so far :-) @xaque208 i have not dig in the Travis-CI failure, the failing test having some "DEPLOY_TO_FORGE=yes" makes me feel good to see it failing… Is this something that is completely fine and safe and that we can fix, or is something missing, e.g. something that ensure this is running only when a new tag is pushed? |
Oh I always forget to disable that bit when I rebase the modulesync repo, but yes disabling that entirely has been my aim. Though, I could probably be convinced otherwise considering how bad I've been about cutting releases. |
I never released anything to the forge (yet… it's still something we intend to do for some or the opus-codium modules), so I can't really give advice here unfortunately, but tell me if there is anything I can do that would help. |
I synced some testing changes to master that might help the tests along here. |
Nice! I rebased my branch on top of master and it seems to be good :-) |
While here, also normalise documentation strings: no coma at end of description.
While here, add tooling to ensure that the REFERENCE.md file is up-to-date.
So, the "unused" parameter was used :-) I rebased the commits on top of master and ameded them to fix this "unused" parameter. |
Nice. This is great, thank you for your efforts here. |
The module has a lot of puppet strings but some parameters lack documentation. This PR intends to add the missing documentation along with tooling to alert contributors when such documentation is missing.
Current status: