Remove nested code blocks from string docs #171
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
MANIFEST.md was being created such that rendering was broken. In particular it contained lots of nested code blocks of yaml inside puppet examples and the 2nd half of the document was not being rendered at all. Luckily redering yaml as puppet code does not look bad.
|
If there's a good way to render yaml examples happy to learn.. |
ekohl
approved these changes
May 12, 2020
| @@ -55,30 +55,23 @@ | |||
| # Name of the utils package, e.g. 'yum-utils', or 'dnf-utils'. | |||
| # | |||
| # @example Enable management of the default repos for a supported OS: | |||
| # ```yaml | |||
There was a problem hiding this comment.
I've seen it elsewhere that this can be useful. Maybe it's useful to file a feature request for YAML highlighting for examples.
| @@ -3,30 +3,30 @@ | |||
| # `%{EPOCH}:%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}`. As a Regex, it | |||
There was a problem hiding this comment.
This type can use a @summary since the summary doesn't render. Was already the case, but maybe good to fix while you're at it.
| # type Yum::PackageDistTag = Regexp[/[0-9a-zZ-Z_\*]+/] | ||
| # | ||
| # # BuildArch: Any string from the list at https://github.com/rpm-software-management/rpm/blob/master/rpmrc.in. Strings are roughly listed from most common to least common to improve performance. | ||
| # BuildArch: Any string from the list at https://github.com/rpm-software-management/rpm/blob/master/rpmrc.in. Strings are roughly listed from most common to least common to improve performance. | ||
| # type Yum::PackageBuildArch = Regexp[/noarch|x86_64|i386|arm|ppc64|ppc64le|sparc64|ia64|alpha|ip|m68k|mips|mipsel|mk68k|mint|ppc|rs6000|s390|s390x|sh|sparc|xtensa/] | ||
| # | ||
| # @note Each field may contain wildcard characters (`*`), but the |
There was a problem hiding this comment.
Looks like @note is not supported
| @@ -3,30 +3,30 @@ | |||
| # `%{EPOCH}:%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}`. As a Regex, it | |||
| # breaks down into five distinct parts, plus the seperators. | |||
| # | |||
| # # EPOCH: An unsigned integer | |||
| # EPOCH: An unsigned integer | |||
| # type Yum::PackageEpoch = Regexp[/[0-9]\*]+/] | |||
There was a problem hiding this comment.
This line doesn't render that well.
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.
Pull Request (PR) description
REFERENCE.md was being created such that rendering was broken. In particular
it contained lots of nested code blocks of yaml inside puppet examples and
the 2nd half of the document was not being rendered at all.
Luckily rendering yaml as puppet code does not look bad.
This Pull Request (PR) fixes the following issues