moardocsfilters #78800
Merged
moardocsfilters #78800
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.14
docs
moardocs moardocs moardocs moardocs also docsfix
ansibot
added
core_review
webknjaz
added
the
ci_verified
There was a problem hiding this comment.
The
docs/docsite/rst/collections/ansible/builtin/random_filter.rst:35:0: duplicate-label: duplicate label random_filter, other instance in /root/ansible/docs/docsite/rst/playbook_guide/playbooks_filters.rst
docs/docsite/rst/collections/ansible/builtin/zip_filter.rst:35:0: duplicate-label: duplicate label zip_filter, other instance in /root/ansible/docs/docsite/rst/playbook_guide/playbooks_filters.rst
errors in the docs bulid sanity test stem from a feature in antsibull-docs that creates shortname labels for backwards compatibility for plugins/modules in ansible.builtin. Since there was no auto-generated docs for tests and filters before, we now have to label collisions because of this...
Both labels random_filter and zip_filter only appear in docs/docsite/rst/playbook_guide/playbooks_filters.rst, and aren't used anywhere else in the documentation (at least the one included in ansible/ansible), so it should be safe to rename these. (If any collection documentation was referring to these labels before, they will now refer to the auto-generated filter docs. I guess that won't be too wrong, so the rename should be really OK.)
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
ansibot
added
core_review
| version_added: "historical" | ||
| short_description: cast into a boolean | ||
| description: | ||
| - Attempt to cast the input into a boolean (C(True) or C(False)) value |
There was a problem hiding this comment.
Suggested change
| - Attempt to cast the input into a boolean (C(True) or C(False)) value | |
| - Attempt to cast the input into a boolean (C(True) or C(False)) value. |
| default: plain | ||
| choices: ['plain', 'decoration', 'erlang', 'c', 'cblock', 'xml'] | ||
| decoration: | ||
| description: string that indicate comment or intermediate comment depending on the style |
There was a problem hiding this comment.
Suggested change
| description: string that indicate comment or intermediate comment depending on the style | |
| description: String that indicates a comment or intermediate comment depending on the style. |
| description: string that indicate comment or intermediate comment depending on the style | ||
| type: string | ||
| begining: | ||
| description : string to indicate the start of a comment block, only available for styles that support multiline comments |
There was a problem hiding this comment.
Suggested change
| description : string to indicate the start of a comment block, only available for styles that support multiline comments | |
| description: String to indicate the start of a comment block. Only available for styles that support multiline comments. |
| description: first list | ||
| type: list | ||
| required: true | ||
| _additional_lis': #TODO: *args, N possible additional lists |
There was a problem hiding this comment.
Suggested change
| _additional_lis': #TODO: *args, N possible additional lists | |
| _additional_list: #TODO: *args, N possible additional lists |
Co-authored-by: Felix Fontein <felix@fontein.de>
| type: string | ||
| default: '\n' | ||
| prefix: | ||
| description : Token to start each line inside a comment block, only available for styles that support multiline comments |
There was a problem hiding this comment.
Suggested change
| description : Token to start each line inside a comment block, only available for styles that support multiline comments | |
| description: Token to start each line inside a comment block, only available for styles that support multiline comments. |
| description : Token to start each line inside a comment block, only available for styles that support multiline comments | ||
| type: string | ||
| prefix_count: | ||
| description : Number of times to add a prefix at the start of a line, when a prefix exists and is usable |
There was a problem hiding this comment.
Suggested change
| description : Number of times to add a prefix at the start of a line, when a prefix exists and is usable | |
| description: Number of times to add a prefix at the start of a line, when a prefix exists and is usable. |
| type: int | ||
| default: 1 | ||
| postfix: | ||
| description : Indicator of the end of each line inside a comment block, only available for styles that support multiline comments |
There was a problem hiding this comment.
Suggested change
| description : Indicator of the end of each line inside a comment block, only available for styles that support multiline comments | |
| description: Indicator of the end of each line inside a comment block, only available for styles that support multiline comments. |
Comment on lines
41
to
42
| prefix_count: | ||
| description : Number of times to add a postfix at the end of a line, when a prefix exists and is usable |
There was a problem hiding this comment.
Suggested change
| prefix_count: | |
| description : Number of times to add a postfix at the end of a line, when a prefix exists and is usable | |
| postfix_count: | |
| description: Number of times to add a postfix at the end of a line, when a prefix exists and is usable |
| type: raw | ||
| required: true | ||
| contianer: | ||
| description: dictionary or list from which to extract a value |
There was a problem hiding this comment.
Suggested change
| description: dictionary or list from which to extract a value | |
| description: Dictionary or list from which to extract a value. |
Comment on lines
+5
to
+6
| - return a list of files that matches the supplied path glob pattern | ||
| - filters run on the controller, so the files are matched from the controller's file system |
There was a problem hiding this comment.
Suggested change
| - return a list of files that matches the supplied path glob pattern | |
| - filters run on the controller, so the files are matched from the controller's file system | |
| - Return a list of files that matches the supplied path glob pattern. | |
| - Filters run on the controller, so the files are matched from the controller's file system. |
ansibot
added
needs_revision
Co-authored-by: Felix Fontein <felix@fontein.de>
ansibot
added
core_review
|
The test |
ansibot
added
ci_verified
mkrizek
removed
the
needs_triage
ansibot
added
core_review
ansibot
added
needs_rebase
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.
moardocs
moardocs
moardocs
moardocs
also docsfix
ISSUE TYPE
COMPONENT NAME
docs