Add 'idempotent' attribute #238
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #238 +/- ##
=======================================
Coverage 96.67% 96.68%
=======================================
Files 112 112
Lines 7560 7561 +1
Branches 1074 1074
=======================================
+ Hits 7309 7310 +1
Misses 173 173
Partials 78 78
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Docs Build 📝Thank you for contribution!✨ This PR has been merged and the docs are now incorporated into |
plugins/doc_fragments/attributes.py
Outdated
| idempotent: | ||
| description: | ||
| - When run twice in a row with the same arguments, the second invocation indicates no change. | ||
| - This assumes that the system controlled/queried by the module has not changed in a relevant way. |
There was a problem hiding this comment.
That would be one of the next steps ;-) I've started the PRs here (c.crypto, c.dns, c.docker) since I know the content of the collections pretty well and was able to add the attribute everywhere. My next step would be to discuss this a bit further (especially the question about having another attribute for whether/when changed parameters are updated, or merging that attribute with this one), and then starting to add it to c.g (since that's going to be a lot of work since it requires good knowledge of every module it is added to).
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
|
@russoz thanks for reviewing this and the other PRs! |
SUMMARY
Adds a new attribute
idempotentfor module documentation, which states whether (resp. under which circumstances) the module is idempotent.Related PRs:
ISSUE TYPE
COMPONENT NAME
module documentation