ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-22 10:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

Use semantic markup (modules r-s) (#6683)

Browse source 
* Use semantic markup.

* Use 'ignore:' for alias reference.

* Ignore sanity errors for older ansible-core versions.

* Improve markup for RHSM modules.

Co-authored-by: Pino Toscano <ptoscano@redhat.com>

* 'ignore:' is no longer needed.

* E() now works better.

---------

Co-authored-by: Pino Toscano <ptoscano@redhat.com>
This commit is contained in:
Felix Fontein 2023-06-15 15:48:51 +02:00 • committed by GitHub
parent 45eb1e3915
commit eff0cb0ed9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
49 changed files with 311 additions and 303 deletions
Download patch file Download diff file Expand all files Collapse all files

12
plugins/modules/rax_files_objects.py
View file

@ -23,7 +23,7 @@ options:
clear_meta:
description:
- Optionally clear existing metadata when applying metadata to existing objects.
Selecting this option is only appropriate when setting I(type=meta).
Selecting this option is only appropriate when setting O(type=meta).
type: bool
default: false
container:
@ -36,7 +36,7 @@ options:
description:
- The destination of a C(get) operation; i.e. a local directory, C(/home/user/myfolder).
Used to specify the destination of an operation on a remote object; i.e. a file name,
C(file1), or a comma-separated list of remote objects, C(file1,file2,file17).
V(file1), or a comma-separated list of remote objects, V(file1,file2,file17).
expires:
type: int
description:
@ -50,8 +50,8 @@ options:
type: str
description:
- >
The method of operation to be performed: C(put) to upload files, C(get) to download files or
C(delete) to remove remote objects in Cloud Files.
The method of operation to be performed: V(put) to upload files, V(get) to download files or
V(delete) to remove remote objects in Cloud Files.
choices:
- get
- put
@ -61,8 +61,8 @@ options:
type: str
description:
- Source from which to upload files. Used to specify a remote object as a source for
an operation, i.e. a file name, C(file1), or a comma-separated list of remote objects,
C(file1,file2,file17). Parameters I(src) and I(dest) are mutually exclusive on remote-only object operations
an operation, i.e. a file name, V(file1), or a comma-separated list of remote objects,
V(file1,file2,file17). Parameters O(src) and O(dest) are mutually exclusive on remote-only object operations
structure:
description:
- Used to specify whether to maintain nested directory structure when downloading objects