This repository has been archived by the owner on May 17, 2024. It is now read-only.
Triple quote long examples docs. #42
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
xavdid
approved these changes
Apr 27, 2018
lib/utils/buildDocs.js
Outdated
| .join('\n')}\n${prepend}\`\`\`` | ||
| : `\`${prepQuote(val)}\``; | ||
| const quoteOrNa = (val, triple = false, prepend = '') => | ||
| val ? quote(val, triple, prepend) : '_n/a_'; | ||
|
|
||
| const formatExample = example => { | ||
| const ex = _.isPlainObject(example) ? _.omit(example, SKIP_KEY) : example; | ||
| return `* ${quoteOrNa( | ||
| // GH parses the newlines in bullets correctly, but it's a good thing to fix | ||
| // docs say Infinity for no line break at all |
There was a problem hiding this comment.
can remove these comments as they're no longer relevant
There was a problem hiding this comment.
Ah yeah -- good call!
lib/utils/buildDocs.js
Outdated
| const quote = (val, triple, prepend = '') => | ||
| triple && val.length > BREAK_LENGTH | ||
| ? `\`\`\`\n${val | ||
| .match(/[^\r\n]+/g) |
There was a problem hiding this comment.
this section is a little opaque. could you add comments about the desired before and after?
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.
Makes those long examples a little more readable.