Skip to content

docs: cleanup module and state docstrings to match behavior (master)#69559

Draft
dwoz wants to merge 1 commit into
saltstack:masterfrom
dwoz:dwoz/docs/docstring-cleanup-master
Draft

docs: cleanup module and state docstrings to match behavior (master)#69559
dwoz wants to merge 1 commit into
saltstack:masterfrom
dwoz:dwoz/docs/docstring-cleanup-master

Conversation

@dwoz

@dwoz dwoz commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

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)

Branches

Per-branch PR — each release branch is being shipped separately because
the affected docstrings have drifted independently across the lines.

issue group 3006.x 3007.x 3008.x master
modules / states / runners / wheel / pillar (above) yes yes yes yes
docker_container / docker_image / aptpkg / netmiko_px / ddns yes yes n/a (extracted) n/a (extracted)

Out of scope (issues from the original list that are no longer

applicable on this branch and need no doc change)

Test plan

  • CI green on the per-branch base.
  • pre-commit run --all-files clean on the touched files
    (verified locally with isolated PRE_COMMIT_HOME).
  • make -C doc html produces no Sphinx warnings on the rendered
    pages for each touched module.
  • python -c "help(salt.modules.<m>.<f>)" round-trips for each
    edited function.

🤖 Generated with Claude Code (Claude Opus 4.7).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

test:full Run the full test suite

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant