Detect the EXAMPLES format and use it #225
Merged
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
|
Examples:
|
samccann
approved these changes
Dec 8, 2023
gotmax23
reviewed
Dec 8, 2023
gotmax23
reviewed
Dec 9, 2023
gotmax23
approved these changes
Dec 9, 2023
|
Thanks! |
|
@gotmax23 thanks for reviewing, merging, and releasing! |
jooola
referenced
this pull request
in ansible-collections/hetzner.hcloud
Dec 11, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [antsibull-docs](https://togithub.com/ansible-community/antsibull-docs) | `>=2.5.0,<2.6` -> `>=2.6,<2.7` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>ansible-community/antsibull-docs (antsibull-docs)</summary> ### [`v2.6.0`](https://togithub.com/ansible-community/antsibull-docs/blob/HEAD/CHANGELOG.rst#v260) [Compare Source](https://togithub.com/ansible-community/antsibull-docs/compare/2.5.0...2.6.0) \====== ## Release Summary Fix parsing of `EXAMPLES` and improve error message ## Minor Changes - Improve error messages when calls to `ansible-doc` fail ([https://github.com/ansible-community/antsibull-docs/pull/223](https://togithub.com/ansible-community/antsibull-docs/pull/223)). ## Bugfixes - When `EXAMPLES` has the format specified by `# fmt: <format>`, this value is used to determine the code block type ([https://github.com/ansible-community/antsibull-docs/pull/225](https://togithub.com/ansible-community/antsibull-docs/pull/225)). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ansible-collections/hetzner.hcloud). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44Ny4yIiwidXBkYXRlZEluVmVyIjoiMzcuODcuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
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.
Currently the ansible-documentation build fails since ansible/ansible#82361 got merged. This PR fixes the handling of
EXAMPLESblocks by using the format specification if provided.Ref: ansible/ansible#82355 (comment)
Ref: https://github.com/ansible/ansible/blob/6ebefaceb6cd0d4961776a94d63a71fc1fc28bc0/test/lib/ansible_test/_util/controller/sanity/yamllint/yamllinter.py#L173-L187