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

Need to focus and unclutter #4

Open
nibalizer opened this issue Sep 24, 2013 · 1 comment
Open

Need to focus and unclutter #4

nibalizer opened this issue Sep 24, 2013 · 1 comment

Comments

@nibalizer
Copy link

https://github.com/hlindberg/misc-puppet-docs/blame/master/data-in-modules.md#L549-L603

This passage started out so strong with the breakdown of the first component of the triplet. But as a reader I am immediately confused because the section on the second element leads off with a discussion of the third element. I would recommend you take the discussion on the third element and put it second, yes this is somewhat confusing but the reader will just roll with it since the first and third elements are easier to understand.

Also on L558 'actual' is probably meant to be 'actually'

@hlindberg
Copy link
Owner

Thanks, at the point where it started to become unfocused and cluttered it became evident that it would be better to document the simplified solution that is about to be available, and then explain the difference between that and the current - i.e. "sorry, but there is lots of redundancy in the original format". The use of the "three values" actually just makes it hard to explain how it really works.

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

No branches or pull requests

2 participants