-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
FI-3261: Add markdown support to input descriptions #546
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #546 +/- ##
==========================================
+ Coverage 84.17% 84.22% +0.05%
==========================================
Files 271 272 +1
Lines 11589 11584 -5
Branches 1279 1279
==========================================
+ Hits 9755 9757 +2
+ Misses 1824 1817 -7
Partials 10 10
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
… FI-3261-markdown-descriptions
I think the font issue is expected but I will take a look at updating it. I'll look into the other issues as well since there have been some minor updates to the inputs modal as a whole. |
@emichaud998 Ok I finally worked out what was going on here -- when adding the Markdown, it can't be indented or it won't be parsed properly. I've added an example in the demo group in the Patient ID description, let me know if that works! |
Stylistically this is pretty jarring and unintuitive for a test writer, which is why in other parts we have the format_markdown method (for example). Unfortunately there isn't an obvious spot to just add this method where Inputs are defined. @Jammjammjamm is there an easy way to add this to Inputs descriptions? Also, aside, I noticed that we forgot to wrap TestKit.description in this method, which I think we'll want to do unless its happening elsewhere. |
I think the easiest thing to do would be to handle this in the serializers. That could be a common place to fix markdown formatting rather than doing it everywhere a markdown string could be defined. |
I opened #564 to make it so that test writers didn't need to manually unindent these. Because it is a backend thing, waiting on @Jammjammjamm to review. |
@AlyssaWang I merged in some backend fixes so that input description markdown doesn't need to be moved all the way back to 0 indentation for it to work, but now we have some minor conflicts that need to be resolved due to the underlying main branch changing slightly. Could you take care of those and verify the functionality still is working and then we can merge this in? |
… FI-3261-markdown-descriptions
Conflicts should be resolved -- I made a couple of changes to fix some of the Ruby lint/test issues but otherwise the same as before. |
Summary
Adds Markdown support to input descriptions. Also replaces the term
requirement
withinput
.Testing Guidance
Check to see that Markdown works properly in descriptions. See
demo_group.rb
for an example.