fix(fluxdoc): adds support for a _soft_ paragraph #4647
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
nathanielc
requested review from
Marwes and
jstirnaman
and removed request for
a team
nathanielc
commented
Apr 5, 2022
| @@ -1294,6 +1299,77 @@ mod test { | |||
| ); | |||
| } | |||
| #[test] | |||
| fn test_value_doc_multiline_headline_no_desc() { | |||
There was a problem hiding this comment.
this test passed without changes to the parser, but I wanted to validate that the normal headline didn't have the same problem as the headline for a parameter within a list item.
nathanielc
commented
Apr 5, 2022
| ); | ||
| } | ||
| #[test] | ||
| fn test_value_doc_code_headline_no_desc() { |
There was a problem hiding this comment.
same thing here, the test passed without changes to the parser, but I wanted to validate that the normal headline didn't have the same problem as the headline for a parameter within a list item.
It is possible for a list item in Markdown to have multiple lines and also not be a _paragraph_. I am calling these _soft_ paragraphs, this change adds support to the parameter parsing to consume these _soft_ paragraphs as the entire headline.
nathanielc
force-pushed
the
fix/fluxdoc-soft-paragraph
branch
from
e311e56
to
0ebd453
Compare
Marwes
approved these changes
Apr 6, 2022
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.
It is possible for a list item in Markdown to have multiple lines and
also not be a paragraph. I am calling these soft paragraphs, this
change adds support to the parameter parsing to consume these soft
paragraphs as the entire headline.
Done checklist