Update fprime cli documentation

[SMorettini]

Originating Project/Creator
Affected Component	Documentation
Affected Architectures(s)
Related Issue(s)
Has Unit Tests (y/n)
Builds Without Errors (y/n)
Unit Tests Pass (y/n)
Documentation Included (y/n)

---

Change Description

Update the documentation of the fprime-cli.

[SMorettini]

The spell-checking is failing for non-existent, should I add it in the exceptions or changed in the documentation? It comes from running fprime-cli --help

[thomas-bc]

If that's outputted by fprime-cli it's probably best to add it to the expected list. Thanks for updating this!

[thomas-bc]

Food for thought:
this pattern of displaying in the docs what the output of a --help command is seems questionable to me. For example, the next release of fprime-gds will yet again modify this output, replacing -r with -d (see here). Are we going to have to remember to update this again then? Most likely, we will forget. Should these things be scrubbed? Could we auto-generate them somehow?

[SMorettini]

I updated the non-existent to nonexistent to solve the spelling issue. Adding it to the expected list didn't work, I think that line_forbidden.patterns has a higher priority than the expected list.

About

Food for thought: this pattern of displaying in the docs what the output of a --help command is seems questionable to me. For example, the next release of fprime-gds will yet again modify this output, replacing -r with -d (see here). Are we going to have to remember to update this again then? Most likely, we will forget. Should these things be scrubbed? Could we auto-generate them somehow?

I agree, I think that if we can autogenerate it would be very interesting but I'm not an expert in CI setup so I don't know how to do it. I think it can also make sense to remove it from the documentation since the user can find it by itself. If you want me to remove it I can do it directly in this pull request. Let me know what you prefer.

[LeStarch]

There is reason to keep this around, but I'd argue in a different format. Like how online Linux man-pages are setup. Autogeneration would be awesome, and it should be relegated to API like documentation rather than inside the user guide.

This is a nice stop-gap, so I'll merge.