Skip to content

Commit d2f54f1

Browse files
committed
(maint) typos and phrasing
1 parent f2cdda7 commit d2f54f1

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

language/resource-api/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ Each resource being managed must be identified by a unique title. Usually this i
7777

7878
If multiple attributes are defined with the `namevar` behaviour, the type SHOULD specify `title_patterns` that will tell Resource API how to get at the attributes from the title. If `title_patterns` is not specified a default pattern is applied, and matches against the first declared `namevar`.
7979

80-
8180
> Note: The order of title_patterns is important. You should declare the most specific pattern first and end with the most generic.
8281
8382
Each title pattern contains the:
@@ -184,7 +183,7 @@ A missing `:should` entry indicates that a resource should be removed from the s
184183

185184
The `set` method should always return `nil`. Any progress signaling should be done through the logging utilities described below. If the `set` method throws an exception, all resources that should change in this call and haven't already been marked with a definite state, will be marked as failed. The runtime will only call the `set` method if there are changes to be made, especially in the case of resources marked with `noop => true` (either locally or through a global flag). The runtime will not pass them to `set`. See `supports_noop` below for changing this behaviour if required.
186185

187-
Both methods take a `context` parameter which provides utilties from the runtime environment, and is decribed in more detail there.
186+
Both methods take a `context` parameter which provides utilities from the runtime environment, and is described in more detail in its own section below.
188187

189188
## Implementing simple providers
190189

@@ -208,17 +207,17 @@ class Puppet::Provider::AptKey::AptKey < Puppet::ResourceApi::SimpleProvider
208207
Once all of that is in place, instead of the `set` method, the provider needs to implement the `create`, `update` or `delete` methods:
209208

210209
* `create(context, name, should)`: This is called when a new resource should be created.
211-
* `context`: provides utilties from the runtime environment, and is decribed in more detail there.
210+
* `context`: provides utilities from the runtime environment, and is described in more detail in its own section below.
212211
* `name`: the name or hash of the new resource.
213212
* `should`: a hash of the attributes for the new instance.
214213

215214
* `update(context, name, should)`: This is called when a resource should be updated.
216-
* `context`: provides utilties from the runtime environment, and is decribed in more detail there.
215+
* `context`: provides utilities from the runtime environment, and is described in more detail in its own section below.
217216
* `name`: the name or hash of the resource to change.
218217
* `should`: a hash of the desired state of the attributes.
219218

220219
* `delete(context, name)`: This is called when a resource should be deleted.
221-
* `context`: provides utilties from the runtime environment, and is decribed in more detail there.
220+
* `context`: provides utilities from the runtime environment, and is described in more detail in its own section below.
222221
* `name`: the name or hash of the resource that should be deleted.
223222

224223
The `SimpleProvider` takes care of basic logging, and error handling.

0 commit comments

Comments
 (0)