[LiquidDoc] Modify paramDescription to be null if empty #737
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
jamesmengo
force-pushed
the
jm/null_param_desc
branch
2 times, most recently
from
6234d28 to
3cf8be9
Compare
jamesmengo
force-pushed
the
jm/null_param_desc
branch
from
3cf8be9 to
dd0cd4d
Compare
jamesmengo
commented
Jan 27, 2025
| @@ -1974,7 +1974,8 @@ function toHtmlSelfClosingElement( | |||
| } | |||
|
|
|||
| function toNullableTextNode(node: ConcreteTextNode | null): TextNode | null { | |||
| if (!node) return null; | |||
| if (!node || node.value === '') return null; | |||
There was a problem hiding this comment.
@charlespwd I would prefer to update the ohm logic, but it wasn't so straightforward since paramDescription is always matched.
Wanted to get a sanity check on this decision, or some help editing ohm!
aswamy
approved these changes
Jan 27, 2025
| @@ -33,6 +33,7 @@ describe('Unit: makeGetLiquidDocDefinitions', () => { | |||
| @param {Number} secondParam - The second param | |||
| @param paramWithNoType - param with no type | |||
| @param paramWithOnlyName | |||
| @param {Number} paramWithNoDescription | |||
There was a problem hiding this comment.
you should also include a test for free-form text to see if it gets picked up by getSnippetDefinition
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.
What are you adding in this PR?
Returns
nullin theliquid-html-parserifparamDescriptionvalue is''.Also added some test coverage in the language server for this case.
stage-2, though we could revisit thischangeset