Skip to content

(MODULES-6771) - Updates to README. #885

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

Merged
merged 1 commit into from
Mar 12, 2018

Conversation

pmcmaw
Copy link
Contributor

@pmcmaw pmcmaw commented Mar 9, 2018

These changes includes:

  1. The removal of 'Unacceptable Examples' to avoid confusion
  2. The removal of hard line breaks
  3. The addition of 'valid values'
  4. Changing IP Addresses wrapped in back ticks to wrap them in single quotes

These changes are being PR'd directly against the release branch as these are required before the module can be released.

@pmcmaw pmcmaw requested a review from jbondpdx March 9, 2018 08:51
@pmcmaw
Copy link
Contributor Author

pmcmaw commented Mar 9, 2018

Hey @jbondpdx,

I have requested your review as these are the changes that we were chatting about last night. Hopefully they are up to scratch. The last few entries I have added the URL to the page for examples, hoping this is sufficient. 👍

Copy link
Contributor

@jbondpdx jbondpdx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one little fix. This looks so great!

README.md Outdated
Match the same things as the `Stdlib::IP::Address` alias, except it will not
match an address that includes an address prefix (e.g., it will match
`192.168.0.6` but not `192.168.0.6/24`).
Match the same things as the `Stdlib::IP::Address` alias, except it will not match an address that includes an address prefix (e.g., it will match '192.168.0.6' but not '192.168.0.6/24').
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.g. is hard for translation; use 'for example' instead please

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see some other ones, so I think you could just do a search and replace.

@jbondpdx jbondpdx merged commit 37d996d into puppetlabs:release Mar 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants