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

r*: normalize docs #9354

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Dec 24, 2024

SUMMARY

Normalize doc blocks.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/read_csv.py
plugins/modules/redfish_command.py
plugins/modules/redfish_config.py
plugins/modules/redfish_info.py
plugins/modules/redhat_subscription.py
plugins/modules/redis.py
plugins/modules/redis_data.py
plugins/modules/redis_data_incr.py
plugins/modules/redis_data_info.py
plugins/modules/redis_info.py
plugins/modules/rhevm.py
plugins/modules/rhsm_release.py
plugins/modules/rhsm_repository.py
plugins/modules/riak.py
plugins/modules/rocketchat.py
plugins/modules/rollbar_deployment.py
plugins/modules/rpm_ostree_pkg.py
plugins/modules/rundeck_acl_policy.py
plugins/modules/rundeck_job_executions_info.py
plugins/modules/rundeck_job_run.py
plugins/modules/rundeck_project.py
plugins/modules/runit.py

@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Dec 24, 2024
- slave_mode
db:
description:
- The database to flush (used in db mode) [flush command].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- The database to flush (used in db mode) [flush command].
- The database to flush (used in DB mode) [flush command].

type: int
flush_mode:
description:
- Type of flush (all the dbs in a redis instance or a specific one) [flush command].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Type of flush (all the dbs in a redis instance or a specific one) [flush command].
- Type of flush (all the DBs in a redis instance or a specific one) [flush command].

this needs to be in the redis.conf in the masterauth variable

- Requires the C(redis-py) Python package on the remote host. You can install it with pip
(pip install redis) or with a package manager. U(https://github.com/andymccurdy/redis-py).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(pip install redis) or with a package manager. U(https://github.com/andymccurdy/redis-py).
(C(pip install redis)) or with a package manager. U(https://github.com/andymccurdy/redis-py).

default: true
disks:
description:
- This option uses complex arguments and is a list of disks with the options name, size and domain.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- This option uses complex arguments and is a list of disks with the options name, size and domain.
- This option uses complex arguments and is a list of disks with the options O(name), O(size), and O(domain).

elements: str
ifaces:
description:
- This option uses complex arguments and is a list of interfaces with the options name and vlan.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- This option uses complex arguments and is a list of interfaces with the options name and vlan.
- This option uses complex arguments and is a list of interfaces with the options O(name) and O(vlan).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch check-before-release PR will be looked at again shortly before release and merged if possible. docs module module plugins plugin (any type) redhat_subscription
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants