[PR #124/39defcf1 backport][stable-10] sar_facts - improves module return docs

[patchback]

This is a backport of PR #124 as merged into main (39defcf).

SUMMARY

This PR improves the return module documentation

RETURN = r'''
ansible_facts:
  description:
    - A dictionary containing the SAR data collected.
    - The value is a list of dictionaries where each dictionary represents a single data point.
    - V(date) The date for the measurement.
    - V(time) The time for the measurement in 24-hour format.
    - Additional keys corresponding to the performance metrics output from the C(sar) command.
  returned: always
  type: complex
  contains:
    sar_cpu:
      description:
        - Dictionary that contains C(cpu) data from C(sar).
        - It contains V(date), V(time) and all others keys from C(sar) data.
        - Most common keys are V(%user), V(%nice), V(%system), V(%idle) and others.
      returned: when O(type) is V(cpu).
      type: dict
    sar_mem:
      description:
        - Dictionary that contains C(memory) data from C(sar).
        - It contains V(date), V(time) and all others keys from C(sar) data.
        - Most common keys are V(%memused), V(%commit) and others.
      returned: when O(type) is V(memory).
      type: dict
    sar_swap:
      description:
        - Dictionary that contains C(swap) data from C(sar).
        - It contains V(date), V(time) and all others keys from C(sar) data.
        - Most common keys are V(%swpused), V(%swpcad) and others.
      returned: when O(type) is V(swap).
      type: dict
    sar_net:
      description:
        - Dictionary that contains C(network) data from C(sar).
        - It contains V(date), V(time) and all others keys from C(sar) data.
        - Most common keys are V(IFACE), V(rxpck/s), V(txpck/s), v(%ifutil) and others.
      returned: when O(type) is V(network).
      type: dict
    sar_disk:
      description:
        - Dictionary that contains C(disk) data from C(sar).
        - It contains V(date), V(time) and all others keys from C(sar) data.
        - Most common keys are V(DEV), V(%util), V(await), V(rkB/s), V(wkB/s) and others.
      returned: when O(type) is V(disk).
      type: dict
    sar_load:
      description:
        - Dictionary that contains C(load) data from C(sar).
        - It contains V(date), V(time) and all others keys from C(sar) data.
        - Most common keys are V(ldavg-1), V(ldavg-5), V(ldavg-15) and others.
      returned: when O(type) is V(load).
      type: dict
'''

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

sar_facts

ADDITIONAL INFORMATION

[3A2BOT]

cc @NomakCooper
click here for bot help

[github-actions]

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and the docs are now incorporated into main:
https://3A2DEV.github.io/ans2dev.general/branch/main

[NomakCooper]

/approve

[repo-command]

Pull request approved by @NomakCooper