Add F Prime terminology translation guide #3260
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomas-bc
requested changes
Feb 24, 2025
|
@thomas-bc sorry about the miss-communication. I specifically asked for this PR as-is extracted from the referenced issue. It was my intent to review the content here and remove the tool-artifacts. I have done that now. Would you take a look now that I've cleaned it up? This was done to ensure @matt392code got credit for the original contribution. |
thomas-bc
reviewed
Feb 24, 2025
There was a problem hiding this comment.
LGTM ! This should likely be added to mkdocs.yml so it can be found on the website
Apologies for the miscommunication
|
Mike asked that I not initiate pull requests without clearing it with him first. He said the table needed work but wanted me to put it in it as a foundation and not finished documentation.
Matt
…On February 24, 2025 6:32:37 PM EST, M Starch ***@***.***> wrote:
@LeStarch commented on this pull request.
> @@ -0,0 +1,84 @@
+# F´ Translation Guide: Software Engineering to F Prime Nomenclature
+
+This guide provides a mapping between common software engineering concepts and their equivalent implementations in the F´ framework. It serves as a reference for developers transitioning to F´ development.
+
+## Data Structures & Containers
+
+| Software Concept | F Prime Equivalent | Notes |
+|-----------------|-------------------|--------|
+| Queue | Os::Queue | Thread-safe queue implementation for RTOS |
+| Array | Fw::Array<T> | Fixed-size array with bounds checking |
+| String | Fw::String | Safe string implementation with size limits |
+| Buffer | Fw::Buffer | Memory buffer with size tracking |
+| Vector | Fw::Array<T> | F Prime uses fixed arrays instead of dynamic vectors |
To be clear, I asked for this exact PR. I want to use this as a jump-off point.
--
Reply to this email directly or view it on GitHub:
#3260 (comment)
You are receiving this because you authored the thread.
Message ID: ***@***.***>
|
LeStarch on Feb 13, 2025 CollaboratorAuthor @matt392code these tables you posted are exactly what we need for this issue. Do you want to pull those tables into a PR? Create: docs/user-guide/framework/fprime-translations.md Add all of the tables you put at the top (everything up to "Example Translations"). I will need to go through and edit some of the data, but want to let you get credit for the initial work.
thomas-bc
reviewed
Feb 26, 2025
thomas-bc
approved these changes
Feb 26, 2025
|
Nice work everyone! |
|
Thank you, Mike!
-----Original Message-----
From: nasa/fprime ***@***.***>
Sent: Feb 27, 2025 2:13 PM
To: nasa/fprime ***@***.***>
Cc: matt392code ***@***.***>, Mention ***@***.***>
Subject: Re: [nasa/fprime] Add F Prime terminology translation guide (PR #3260)
Nice work everyone!
—
Reply to this email directly, view it on GitHub (#3260 (comment)), or unsubscribe (https://github.com/notifications/unsubscribe-auth/ABZQUY2CHYDRT274K72MHTT2R5PU5AVCNFSM6AAAAABXXJRNO6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBYHA3TKMRYGY).
You are receiving this because you were mentioned.Message ID: ***@***.***>
LeStarch left a comment (nasa/fprime#3260) (#3260 (comment))
Nice work everyone!
—
Reply to this email directly, view it on GitHub (#3260 (comment)), or unsubscribe (https://github.com/notifications/unsubscribe-auth/ABZQUY2CHYDRT274K72MHTT2R5PU5AVCNFSM6AAAAABXXJRNO6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOBYHA3TKMRYGY).
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
"Resolves #1251 - Creates documentation to translate software engineering concepts to F´ nomenclature"
LeStarch on Feb 13, 2025
@matt392code these tables you posted are exactly what we need for this issue. Do you want to pull those tables into a PR? Create:
docs/user-guide/framework/fprime-translations.md
Add all of the tables you put at the top (everything up to "Example Translations"). I will need to go through and edit some of the data, but want to let you get credit for the initial work.
Change Description
Adds a new documentation file that translates common software engineering concepts to F´ terminology. The guide includes mappings for:
Rationale
This documentation helps developers transition to F´ by providing clear mappings between familiar software concepts and their F´ equivalents, as requested in issue #1251.
Testing/Review Recommendations
Please review the terminology mappings for accuracy and completeness. The documentation is based on the tables previously posted in issue #1251.
Future Work