Edits on resource api readme #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DavidS
reviewed
Jan 30, 2018
README.md
Outdated
| @@ -46,6 +46,7 @@ Do you want to continue and make these changes to your module? Yes | |||
| 2 files modified. | |||
|
|
|||
| ~/git/example$ | |||
|
|
|||
README.md
Outdated
| @@ -72,7 +73,7 @@ The three generated files are the type, the actual implementation, and unit test | |||
|
|
|||
| ### Writing the Type | |||
|
|
|||
| The type contains the shape of your resources. The template renders the minimally necessary `name`, and `ensure` attributes. You can modify their description and the name's type to match your resource. Add more attributes as you see fit. | |||
| The type contains the shape of your resources. The template provides the necessary `name` and `ensure` attributes. You can modify their description and the name's type to match your resource. Add more attributes as you wish. | |||
There was a problem hiding this comment.
"... as you need."? Developers are pretty much on their own from here on, and need to make the changes they require for their goals.
We'll need to add more info on what/how they can do this later.
|
Except for two minor things this is good to go. |
DavidS
approved these changes
Jan 30, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.