Expand Thorium documentation with concrete examples#68857
Expand Thorium documentation with concrete examples#68857edlitmus wants to merge 3 commits intosaltstack:masterfrom
Conversation
|
Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here's some information that may help as you continue your Salt journey. There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar. |
What does this PR do?
Expands the Thorium documentation with concrete cookbook-style examples and adds focused unit tests that exercise the documented patterns.
What issues does this PR fix or reference?
Fixes N/A
Previous Behavior
Thorium's topic documentation and generated reference pages documented only a small subset of the available patterns, with minimal end-to-end examples.
New Behavior
The Thorium docs now include concrete examples for:
reg.setwithcheck.containsreg.listandcheck.len_gtecalc.meantimer.holdlocal.cmd,runner.cmd, andwheel.cmdfile.savestatus.regandkey.timeoutThe branch also adds unit coverage for those example flows.
Merge requirements satisfied?
[NOTICE] Bug fixes or features added to Salt require tests.
This PR changes documentation and tests only and does not change user-facing runtime behavior, so no changelog entry is needed per
doc/topics/development/changelog.rst.Commits signed with GPG?
No
Testing
PYTHONPYCACHEPREFIX=/tmp/codex-pycache python3 -m py_compile salt/thorium/*.pygit diff --checkPYTHONPATH=/tmp/salt-test-deps python3 -m pytest -q tests/pytests/unit/thorium/test_examples.pyPYTHONPATH=/tmp/salt-nox python3 -m nox -e "test-3(coverage=False)" -- tests/pytests/unit/thorium/test_examples.pyPRE_COMMIT_HOME=/tmp/pre-commit-cache pre-commit run --files ...Generic hooks passed and
blackreformatted the new test file. The remaining Salt-specific hook failures were local environment issues from homebrewpre-commitrunning under Python 3.14, while this repo only carriesrequirements/static/citool constraints through Python 3.13.