docs: cleanup module and state docstrings to match behavior (master)#69559
Draft
dwoz wants to merge 1 commit into
Draft
docs: cleanup module and state docstrings to match behavior (master)#69559dwoz wants to merge 1 commit into
dwoz wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Batch cleanup of state and execution-module docstrings to match
actual behavior. No code changes; documentation only.
Issues addressed (each linked below as
Refs #N)slack_notify.call_hook— documented the configuration keyas
identifierinstead ofhook; added a minion-config example.salt.modules.file.seek_read— second parameter issize,not
seek.salt.modules.file.find— the option name isowner, notuser.salt.states.pkgrepo.managed— passingenabled=Falseisequivalent to
disabled=True, notdisabled=False.salt.states.pkgrepo.managed— added thehkp://keyserverworkaround note.
salt.wheel.key— documented the__func_alias__mapping(
list_→key.list,key_str→key.print).salt.states.virtualenv_mod— surfaced thevirtualenvvirtual name and pointed atsalt.modules.virtualenv_mod.createfor unmapped kwargs.salt.states.aptpkg— surfaced theaptvirtual name.salt.modules.groupadd— surfaced thegroupvirtual name.salt.states.file.rename— documented directory support.salt.states.file.copy_— added a pointer tosalt.modules.cp.get_file.salt.states.file.blockreplace— documented thestart/end marker overlap restriction.
salt.states.service.running— documentedsigmatchingagainst shell special characters.
salt.states.service.running— documentedthe
reloadandfull_restartmod-watch options, and added anote about systemd
daemon-reloadordering.salt.modules.cmdmod.run— documentedrunasgroup preservation on Linux and the Windows password requirement.
salt.states.user.present— flagged Windows-unsupporteduid,gid,allow_uid_change,allow_gid_change.salt.states.win_pki— listed the available certificatestores and how to enumerate them with PowerShell.
salt.proxy.netmiko_px— distinguishedkeepalive(in-bandKEEPALIVE packets) from
always_alive(connection lifecycle).salt.states.postgres_privileges— fixed copy-pastedmaintenance_dbdescription.salt.pillar.file_tree— corrected the example so therendered pillar tree matches the on-disk layout.
salt.modules.saltcheck— removed a duplicated jinja/setupexample block; clarified the
assertiondefinition.salt.modules.file.chown— documented the broken-symlinklchownfallback.salt.runners.jobs.last_run— rewrote the description andadded parameter documentation.
salt.states.docker_container.running— documented thatcommandaccepts either a string or a YAML list.salt.states.docker_image.present— clarified thatslsaccepts a comma-separated string only (not a YAML list).
salt.states.docker_container.running— corrected thehostname fallback wording.
Branches
Per-branch PR — each release branch is being shipped separately because
the affected docstrings have drifted independently across the lines.
Out of scope (issues from the original list that are no longer
applicable on this branch and need no doc change)
linux_acl.list_absent perms— already removed from thedocstring on every active branch.
git grepfinds zero hitsinside
salt/andtests/; the remaining hits are inAUTHORS, the Windows installer and a tutorial RST file that PR9is not allowed to touch.
keystorereferences — the module itself still exists on3006.x / 3007.x and has been removed entirely on 3008.x / master,
so the docs are correct on each branch.
param:defaultformatting reported6 years ago is no longer present in
salt/modules/state.py.__virtualname__listing) — handled for themodules that are also flagged by other linked issues
(
groupadd → group,aptpkg → apt,virtualenv_mod → virtualenv). A blanket sweep across the remaining ~50 modulesis deferred to a follow-up PR to keep this one reviewable.
DDNS Module configuration structure. #52650 (DDNS minion-config layout) and [DOCS] Confusion with "kwarg" vs. "kwargs" #64283 (Salt-API kwarg
schema) all want changes inside
doc/**.rstfiles; PR9 isdocstring-only by charter — those are deferred to PR8 (states) /
PR5 (pillar) RST passes.
Test plan
pre-commit run --all-filesclean on the touched files(verified locally with isolated
PRE_COMMIT_HOME).make -C doc htmlproduces no Sphinx warnings on the renderedpages for each touched module.
python -c "help(salt.modules.<m>.<f>)"round-trips for eachedited function.
🤖 Generated with Claude Code (Claude Opus 4.7).