-
Notifications
You must be signed in to change notification settings - Fork 25
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
ogma-cli
: Table of contents in README does not match order of contents
#88
Comments
Change Manager: Confirmed that the issue exists. |
Technical Lead: Confirmed that the issue should be addressed. |
Technical Lead: Issue scheduled for Ogma 1.(0+X).(8+Y). Fix assigned to: @ivanperez-keera. |
The table of contents in the README lists C structs ahead of the ROS and FPrime backends, but the order of in the puts those backends first. This commit updates the TOC to reflect the current order.
Implementor: Solution implemented, review requested. |
The table of contents in the README lists C structs ahead of the ROS and FPrime backends, but the order of sections in the file puts those backends first. This commit updates the TOC to reflect the current order.
Change Manager: Verified that:
|
Change Manager: Implementation ready to be merged. |
Description
The table of contents in the README lists C structs ahead of the ROS and FPrime backends, but the order of sections in the file puts those backends first. The TOC should be updated to reflect the current order.
Type
Additional context
None.
Requester
Method to check presence of bug
The issue is with the documentation. There is no good, simple automated way to check that it is correct.
Because it's not a programming issue, visual inspection is OK.
Expected result
The README's TOC lists the main Copilot, cFS, ROS and FPrime backends first, and then lists the C structs parsing features.
Desired result
The README's TOC lists the main Copilot, cFS, ROS and FPrime backends first, and then lists the C structs parsing features.
Proposed solution
Change the order of elements in the table of contents in the README, to put ROS and FPrime ahead of C structs everywhere.
Further notes
None.
The text was updated successfully, but these errors were encountered: