Documentation updates for issue 332 #382
Merged
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.
Change Description
This PR aims to resolve all but one outstanding documentation issue in #332.
Rationale
@saba-ja 👋🏻 Some updates and questions for you:
The broken link was fixed in
devel
by Correct link to autocomplete page #362.What specific information needs to change for the unit testing tutorial to be accurate?
Fixed in this PR.
The text appears sufficiently similar between
devel
andupdate/ground-prototype
that I've added a fix todevel
in this PR. Specifically, I added a generate command based on order of operations in the Ref tutorial. Please verify for accuracy. 🙇🏻Fixed in this PR.
A fix doesn't appear in
devel
yet either, so I've added it here.Based on Update fprime-gds option and path being used in INSTALL.md #324, it looks like
-d
was replaced with-r
. However, unlike Update fprime-gds option and path being used in INSTALL.md #324, substitution fails here:Subsequently:
fprime/Ref (devel) $ fprime-gds -r . [ERROR] binary location Darwin/bin does not exist
Likewise:
fprime/Ref (devel) $ cd .. fprime (devel) $ fprime-gds -r Ref/ [ERROR] binary location Ref/Darwin/bin does not exist
Note that
fprime/Ref (devel) $ fprime-gds
appears to work as intended.Given errors on
Darwin/bin
, it seems like there are non-obvious things happening under the hood. @Joshua-Anderson 👋🏻 Can you please verify whether this particular command requires a flag; and if so, what that flag and syntax should be?Testing/Review Recommendations
Verify that the
fprime-util generate --ut
command is correct, and that the overall build procedure succeeds.Verify that a change inferred from Math Component F' Tutorial #171 is correct for
devel
.Verify the correct syntax for the ground system build command.
Future Work
Rewrite for general clarity and adherence to style guide.