check_mode attribute description should reflect their support status
Closed this issue · 2 comments
Right now the attribute description for check_mode always says
Can run in check_mode and return changed status prediction without modifying target
Even if the module explicitly doesn't support check mode (support none) like in the uri example. I can see this being confusing for people reading the docs who might skip over the Support side and read Description thinking this does support check mode when it does not.
I think the description for entries where check mode isn't supported should be updated to actually say something like "this module does not support check mode" in the field.
Related: ansible/ansible#82427
@jborean93 - I suppose we could blank out the description field if the support field == none for all attributes. What do you think @felixfontein ?
The text shown here is defined by the module (or plugin) itself, not by antsibull-docs. Most modules use the default text coming from ansible-core's action_common_attributes docs fragment: https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/doc_fragments/action_common_attributes.py#L13.
Closing since this is unrelated to antsibull-docs.