Skip to content

Commit fb1fe0a

Browse files
authored
copy-edit suggestions
1 parent 9587648 commit fb1fe0a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
### Overview
44

5-
The resource module builder is an Ansible playbook that helps developers scaffold and maintain an Ansible network resource modules.
5+
The resource module builder is an Ansible Playbook that helps developers scaffold and maintain an Ansible network resource module.
66

77
**Capabilities**
88
- Use a defined model to scaffold a resource module directory layout and initial class files.
9-
- Scaffold either an ansible role or collection.
10-
- Subsequent uses of RMB will only replace the module arspec and file containing the module doc string.
11-
- Complex examples can be stored along side the model in the same directory
9+
- Scaffold either an Ansible role or a collection.
10+
- Subsequent uses of the Resource Module Builder (RMB) will only replace the module arspec and file containing the module doc string.
11+
- Complex examples can be stored along side the model in the same directory.
1212
- Maintain the model as the source of truth for the module and use RMB to update the source files as needed.
1313
- Generates working sample modules for both `<network_os>_<resource>` and `<network_os>_facts`
1414

@@ -228,7 +228,7 @@ def main():
228228

229229
`module_utils/<ansible_network_os>/facts/<resource>/`.
230230

231-
- Populate facts for the resource
231+
- Populate facts for the resource.
232232
- Entry in `module_utils/<ansible_network_os>/facts/facts.py` for `get_facts` API to keep
233233
`<ansible_network_os>_facts` module and facts gathered for the resource module in sync
234234
for every subset.
@@ -237,10 +237,10 @@ def main():
237237

238238
`module_utils/<ansible_network_os>/<config>/<resource>/`.
239239

240-
- Implement `execute_module` API that loads the config to device and generates result with
240+
- Implement `execute_module` API that loads the config to device and generates the result with
241241
`changed`, `commands`, `before` and `after` keys.
242-
- Call `get_facts` API that returns the `<resource>` config facts or Return the diff if the
243-
device has onbox support diff support.
242+
- Call `get_facts` API that returns the `<resource>` config facts or return the diff if the
243+
device has onbox diff support.
244244
- Compare facts gathered and given key-values if diff is not supported.
245245
- Generate final config.
246246

0 commit comments

Comments
 (0)