Skip to content
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

Clean up docs #62

Merged
merged 4 commits into from
Oct 9, 2017
Merged

Conversation

alex-harvey-z3q
Copy link
Contributor

@alex-harvey-z3q alex-harvey-z3q commented Oct 5, 2017

commit bece309
Author: Alex Harvey
Date: Fri Oct 6 00:27:54 2017 +1100

(maint) Use forge_modules in .fixtures.yml

Replaces use of the Git repos for stdlib and concat in .fixtures.yml to
instead pull from the Forge. This is faster, results in a lot less data
transferred, and is arguably better for testing.

commit a88a727
Author: Alex Harvey
Date: Fri Oct 6 00:20:47 2017 +1100

(maint) Add a better example and tests

The example in the docs for extra_config_section of an array of hashes
is quite confusing, as it leads the reader to believe that the best way
of implementing refresh_patterns is via extra_config_section.

Here, I replace this with a more realistic example using always_direct.

Further, I add a passing unit test case for the array of hashes case.

commit 74f80a2
Author: Alex Harvey
Date: Fri Oct 6 00:02:10 2017 +1100

(docs) Make examples comply with style guide

Bring all examples in the README.md into compliance with the style guide
sections on indentation and whitespace.

Bring all examples in the README.md into compliance with the style guide
sections on indentation and whitespace.
@traylenator
Copy link
Contributor

@alexharv074 all seems good and makes sense. Just a trivial robocop thingy to fix.

The example in the docs for extra_config_section of an array of hashes
is quite confusing, as it leads the reader to believe that the best way
of implementing refresh_patterns is via extra_config_section.

Here, I replace this with a more realistic example using always_direct.

Further, I add a passing unit test case for the array of hashes case.
Replaces use of the Git repos for stdlib and concat in .fixtures.yml to
instead pull from the Forge. This is faster, results in a lot less data
transferred, and is arguably better for testing.
@alex-harvey-z3q
Copy link
Contributor Author

So, Rubocop is configured to stop us using trailing commas after the last element of a Hash, whereas the Puppet Style Guide insists on trailing commas after the last elements of Hashes. :)

The hash of arrays example of extra_config_sections in the unit tests
did not appear in the README.md and this patch fixes that up.
@alex-harvey-z3q
Copy link
Contributor Author

hey @traylenator , any chance I could get this one merged now - I have a bunch of features to merge and if this simple one was merged immediately it would simplify things a lot from my end! Thanks.

@traylenator traylenator merged commit 4db605d into voxpupuli:master Oct 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants