Skip to content

docs: restore loop cycle error guidance#1767

Merged
Fizzadar merged 1 commit into
pyinfra-dev:3.xfrom
puneetdixit200:docs/restore-loop-cycle-errors
May 28, 2026
Merged

docs: restore loop cycle error guidance#1767
Fizzadar merged 1 commit into
pyinfra-dev:3.xfrom
puneetdixit200:docs/restore-loop-cycle-errors

Conversation

@puneetdixit200

Copy link
Copy Markdown
Contributor

Summary

  • restore the missing Loops & Cycle Errors section in docs/deploy-process.rst
  • add a stable #loops-cycle-errors anchor for the link referenced by the cycle error message
  • document using host.loop to disambiguate operation ordering inside loops

Fixes #1494.

Validation

  • git diff --check -- docs/deploy-process.rst
  • DOCS_VERSION=latest uv run --python 3.14 --group docs sphinx-build -b html docs build/docs
  • rg -n "loops-cycle-errors|Loops & Cycle Errors" build/docs/deploy-process.html docs/deploy-process.rst
  • uv run --python 3.14 pytest tests/test_cli/test_cli_deploy.py::TestCliDeployState::test_deploy -q

AI assistance disclosure

This contribution was prepared with assistance from OpenAI Codex. I reviewed the AI policy, issue context, existing host.loop implementation, generated documentation output, and validation results before submitting.

@wowi42 wowi42 added the documentation Issues with docs/examples/docstrings. label May 20, 2026

@Fizzadar Fizzadar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for putting this back @puneetdixit200!

@Fizzadar Fizzadar merged commit 903256c into pyinfra-dev:3.x May 28, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Issues with docs/examples/docstrings.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cycle error in 3.5.1 and missing docs

3 participants