#87542·ansible

Dangling sentence in `ansible.builtin.user` documentation

Author: delta512Created Sep 16, 2026Updated Sep 16, 2026
Labelsmoduleneeds_triagehas_prdocsaffects_2.21

Summary

Dear maintainers,

I was reading the documentation (branch latest, applies to version 14) on the password option for the ansible.builtin.user module and found this odd line.

I can perfectly get the intended meaning, though it sounds like a sentence with a hidden, suspended ending.

This issue is not a pull request because I'm not sure how you prefer this sentence to look like. IMO, just changing the preceding full stop into a comma and making Since all lowercase should suffice:

When the password is passed as an argument, the M(ansible.builtin.user) module will always return changed to C(true) for macOS systems, since macOS no longer provides access to the hashed passwords directly.

Looking forward to hear your opinion. Cheers Activity

Issue Type

Documentation Report

Component Name

lib/ansible/modules/user.py

Ansible Version

$ ansible --version
ansible [core 2.21.4]
  config file = None
  configured module search path = ['/home/$USER/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3.14/site-packages/ansible
  ansible collection location = /home/$USER/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.14.7 (main, Aug 10 2026, 07:46:56) [GCC 16.1.1 20260728] (/usr/bin/python)
  jinja version = 3.1.6
  pyyaml version = 6.0.3 (with libyaml v0.2.5)

Configuration

# if using a version older than ansible-core 2.12 you should omit the '-t all'
$ ansible-config dump --only-changed -t all
[WARNING]: Deprecation warnings can be disabled by setting `deprecation_warnings=False` in ansible.cfg.
[DEPRECATION WARNING]: oneline has been deprecated. Use another callback plugin, or vendor and/or move the oneline callback to a collection. This feature will be removed from ansible-core version 2.23.
Origin: <unknown>

oneline

[DEPRECATION WARNING]: tree has been deprecated. Use another callback plugin, or vendor and/or move the tree callback to a collection. This feature will be removed from ansible-core version 2.23.
Origin: <unknown>

tree

CONFIG_FILE() = None

GALAXY_SERVERS:

OS / Environment

Arch Linux, Firefox 155.0.1

Additional Information

A new reword of the last two sentences could speed up the reading time and let users understand more quickly.

This is being duplicated as suggested by the triage bot.

Code of Conduct

  • I agree to follow the Ansible Code of Conduct