Add markdown formatting to input descriptions. #564
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
Jammjammjamm
approved these changes
Dec 2, 2024
AlyssaWang
added a commit
that referenced
this pull request
Dec 17, 2024
* add markdown descriptions to text input * replace requirement with input * update deprecated prop * replace react markdown with markdown * add example * fix broken test * Add markdown formatting to input descriptions. (#564) * fix lint errors * resolve preset errors --------- Co-authored-by: Rob Scanlon <robscanlon@gmail.com>
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.
Summary
This adds some logic that formats input description markdown in the serializer. This implementation assumes our eventual movement of unindenting texts automatically at the serialization level instead of earlier in the process.
I put this in another PR to merge into the base PR because I would like @Jammjammjamm to review and decide if we should just shelve this until a bigger refactor later, or if it is clean enough to get into the other markdown PR so we can fully 'ship' an input markdown feature without having the test writer unindent manually for this specific case.
Testing Guidance
Demo Suite > Demo Group 1 > Demo Group Instance 1should have proper markdown description in the group, as well as in one of the inputs when you 'Run' it.