fix: variable type markdown formatting #5931
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
williamw2
requested review from
awentzel,
chrisdholt,
Falkicon,
EisenbergEffect,
janechu and
nicholasrice
as code owners
chrisdholt
approved these changes
May 3, 2022
chrisdholt
merged commit a4ba787
into
users/chhol/remove-enums-in-favor-of-const-objects
chrisdholt
pushed a commit
that referenced
this pull request
May 3, 2022
chrisdholt
added a commit
that referenced
this pull request
May 3, 2022
* convert enums to const objects * convert component class enums to const objects and add supported types * Change files * convert orientation enum to const object with corresponding type * Change files * Fixed variable type formatting (#5931) Co-authored-by: William Wagner <[email protected]>
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
📖 Description
This fixes the markdown formatting cleanup for variable types. The CEM markdown generator reads from the variable type property rather than the description or default properties when generating the markdown for variables.
However, the type is rendered as a single line string within a table cell and is pretty well unreadable when comments are included within the type. This fix addresses the immediate issue but we should probably discuss how we want to format these instances to make them more useful.
🎫 Issues
👩💻 Reviewer Notes
📑 Test Plan
✅ Checklist
General
$ yarn changeComponent-specific
⏭ Next Steps