[backport][2.9][PR #70446] Refactor Python API examples and docs #70851
Conversation
This file contains 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
ansibot
added
affects_2.9
ansibot
added
the
stale_ci
|
@webknjaz Can you resolve the two conflicts? |
|
Oh it! |
It is a partial backport of ansible#70224 (partially cherry picked from commit 4816bb4)
PR ansible#70446: it's a follow-up for ansible#70445. It includes a merge of `examples/scripts/uptime.py` and a similar code snippet from `docs/docsite/rst/dev_guide/developing_api.rst`. This patch also changes the docs RST file to include contents of the example file instead of holding a copy of a similar code. (cherry picked from commit 20bb915)
webknjaz
force-pushed
the
backports/pr-70446-2.9
branch
from
6d5689a
to
ad0d944
Compare
|
@relrod done! |
ansibot
removed
the
stale_ci
|
Thanks much! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
Backport of 8d97c8c + partial backport of 4816bb4. It should be merged on top of PR #70842
This change is a follow-up for #70445. When I looked at #69758, I noticed that
there's two places with almost the same example in the repo.
It'd be way easier to maintain just one piece of code and include it in other
place dynamically.
It's basically a merge of two almost identical examples originally
stored as a Python module + its copy-paste in the docs.
The patch also changes the docs RST file to include contents of the example
file instead of holding a copy of similar code.
ISSUE TYPE
COMPONENT NAME
docs/docsite/rst/dev_guide/developing_api.rst
examples/scripts/uptime.py
ADDITIONAL INFORMATION
N/A