-
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-3188: Update documentation on cli_context options. #535
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #535 +/- ##
=======================================
Coverage 84.00% 84.00%
=======================================
Files 260 260
Lines 11361 11361
Branches 1252 1252
=======================================
Hits 9544 9544
Misses 1807 1807
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. |
The first example should be valid - that's how we use it in g10 ( https://github.com/onc-healthit/onc-certification-g10-test-kit/blob/7442075988e9ccf86046669a114234abc682790c/lib/onc_certification_g10_test_kit.rb#L92 ) and the EOM test kit ( https://github.com/inferno-framework/eom-test-kit/blob/83e184dd7109a4277c0a7128310eb647ba9f7868/lib/eom_test_kit/eom_test_suite.rb#L46 )
|
9c81b7d
to
5b751a2
Compare
Ah, great point @dehall! I completely missed that. I do think that it would be a good idea to just call out the difference in the examples there, so I updated it. Also, I think it would still be a good idea to include that exampleUrl param, as I was looking for that anyhow. Also, I assumed that this was a problem that was fixed in inferno-framework docs site, but turns out that was something similar but unrelated. I was just in the wrong mindset here. |
Co-authored-by: Dylan Hall <dehall@mitre.org>
Summary
Updates docs to remove redundant example that is also bad ruby. I believe we had already gotten the bad ruby example fixed on the framework site but didn't get it fixed here.
Also, figured we might as well include the exampleURL flag as an example because that was the one I actually wanted to use when i was looking at this documentation.
Testing Guidance
I suppose you could regenerate the docs as explained in the readme. Also, I haven't tried out that example url flag technically, but grabbed it from the wrapper UI config so it should work.