add details on some plugin options - AI-assisted #2813
Conversation
This file contains hidden or 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
|
Okay made the changes. Can you take another look @felixfontein ? |
samccann
commented
Jul 16, 2025
Co-authored-by: Felix Fontein <[email protected]>
samccann
commented
Jul 16, 2025
felixfontein
approved these changes
Jul 16, 2025
oraNod
reviewed
Jul 21, 2025
Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Felix Fontein <[email protected]>
| @@ -63,18 +63,67 @@ To define configurable options for your plugin, describe them in the ``DOCUMENTA | |||
| description: describe this config option | |||
| default: default value for this config option | |||
| env: | |||
| - name: NAME_OF_ENV_VAR | |||
| - name: MYCOLLECTION_NAME_OF_ENV_VAR | |||
There was a problem hiding this comment.
Suggested change
| - name: MYCOLLECTION_NAME_OF_ENV_VAR | |
| - name: MYCOLLECTION_NAME_ENV_VAR_NAME |
could it be something like that? it's not much longer.
MYCOLLECTION_NAME_OF_ENV_VAR sounds a bit confusing to me, especially the OF part.
If as-is is crystal clear for everyone else, please ignore the suggestion.
Same for ini and vars items.
Comment on lines
+116
to
+120
| * Keywords | ||
| * CLI settings | ||
| * Environment variables | ||
| * Values defined in ``ansible.cfg`` | ||
| * Default value for the option, if present. |
There was a problem hiding this comment.
Suggested change
| * Keywords | |
| * CLI settings | |
| * Environment variables | |
| * Values defined in ``ansible.cfg`` | |
| * Default value for the option, if present. | |
| * Keywords | |
| * CLI settings | |
| * Environment variables (``env``) | |
| * Values defined in ``ansible.cfg`` | |
| * Default value for the option, if present. |
should we mention in brackets or anyhow the sources for each item not to make people match in heads?
felixfontein
approved these changes
Jul 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #2673
Should have done this in 2 commits (AI-generated, then human adapted). Lines 78-93 are predominantly generated.
To fix this bug, I fed the following into Cursor chat mode:
Fix the documentation problems from @https://github.com/ansible/ansible-documentation/issues/2673