Skip to content
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

Merged
merged 4 commits into from
Oct 2, 2024

Conversation

arscan
Copy link
Contributor

@arscan arscan commented Oct 1, 2024

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.

@arscan arscan requested a review from dehall October 1, 2024 20:34
Copy link

codecov bot commented Oct 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.00%. Comparing base (3ceecba) to head (36ecb03).
Report is 1 commits behind head on main.

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           
Flag Coverage Δ
backend 92.11% <ø> (ø)
frontend 79.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@arscan arscan requested a review from Jammjammjamm October 1, 2024 20:41
@dehall
Copy link
Contributor

dehall commented Oct 1, 2024

@arscan arscan force-pushed the fi-3188-fix-cli-context-doc branch from 9c81b7d to 5b751a2 Compare October 1, 2024 21:13
@arscan
Copy link
Contributor Author

arscan commented Oct 1, 2024

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>
@arscan arscan merged commit 4ab105d into main Oct 2, 2024
10 checks passed
@arscan arscan deleted the fi-3188-fix-cli-context-doc branch October 2, 2024 13:44
@Shaumik-Ashraf Shaumik-Ashraf mentioned this pull request Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants