mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-20 04:51:43 -07:00
DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string Added deprecation warning to moduledev.rst and remove deprecated example from it Fixed up a few typos and uppercased some acronyms. add consistency to how EXAMPLES are formatted
This commit is contained in:
parent
39aa5e5eac
commit
5c69918d53
88 changed files with 914 additions and 628 deletions
|
@ -47,16 +47,20 @@ options:
|
|||
|
||||
author: Afterburn
|
||||
notes: []
|
||||
examples:
|
||||
- code: "pacman: name=foo state=installed"
|
||||
description: install package foo
|
||||
- code: "pacman: name=foo state=absent"
|
||||
description: remove package foo
|
||||
- code: "pacman: name=foo,bar state=absent"
|
||||
description: remove packages foo and bar
|
||||
- code: "pacman: name=bar, state=installed, update_cache=yes"
|
||||
description: update the package database (pacman -Syy) and install bar (bar will be the updated if a newer version exists)
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Install package foo
|
||||
- pacman: name=foo state=installed
|
||||
|
||||
# Remove package foo
|
||||
- pacman: name=foo state=absent
|
||||
|
||||
# Remove packages foo and bar
|
||||
- pacman: name=foo,bar state=absent
|
||||
|
||||
# Update the package database (pacman -Syy) and install bar (bar will be the updated if a newer version exists)
|
||||
- pacman: name=bar, state=installed, update_cache=yes
|
||||
'''
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue