Fix example when processed as asciidoc #116
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
The `fields` entry example consists of a dictionary surrounded by quotes. This causes problems when the example is used for documentation in asciidoc format, as it is interpreted as an escaped attribute, and the docs generation fails because it cannot find a "key1" attribute. Fixed by removing the quotes.
webmat
approved these changes
Sep 18, 2018
|
I'd like to wait for Nic to chime in after his vacation, though. He's obviously more well versed with the details here. |
|
I'm pretty sure we will hit other issues down the road with these but then can use other methods in yaml like using |
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.
The
fieldsentry example consists of a dictionary surrounded by quotes. This causes problems when the example is used for documentation in asciidoc format, as it is interpreted as an escaped attribute, and the docs generation fails because it cannot find a "key1" attribute.Fixed by removing the quotes around the example, which isn't perfect because it looks a bit ugly in the generated README.md and CSV formats.
Suggestions welcome.