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

Fix #1147, Correct typos in documentation, print statements, and comments #1137

Merged
merged 3 commits into from
Sep 10, 2021

Conversation

thnkslprpt
Copy link
Contributor

@thnkslprpt thnkslprpt commented Aug 25, 2021

Describe the contribution
Fixed various minor text typos in README docs, comments and a few debug/error message strings.

Testing performed
None (non-executable code).

Expected behavior changes
None. Code execution is unchanged/unaffected.

System(s) tested on
n/a

Additional context
n/a

Code contributions
n/a

Copy link
Contributor

@astrogeco astrogeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very thorough, thank you! Did you use a spellcheck script?

My only request is that you split commits with one only dealing with documentation typos (.txt and .md files) another commit that addresses "comment" typos and one last commit that addresses actual source code typos (like the print statement for seMinitialize).

@thnkslprpt
Copy link
Contributor Author

Yeah no worries Gerardo - I thought it might be better to split them but wasn't sure.
I'll split up all of the remaining pull requests for the submodules that haven't been merged in yet.

Re. spellcheck script? No - maybe if I knew how to do that I would have haha!
Most were found by CTRL+F'ing typos that I noticed and finding the same typo littered throughout the the various submodules. For some of the more 'wordy' files I also pasted them into Google Docs and checked what it found.

@thnkslprpt thnkslprpt marked this pull request as draft September 1, 2021 14:08
README.md Outdated Show resolved Hide resolved
@thnkslprpt
Copy link
Contributor Author

This is very thorough, thank you!

Haha - re. 'thorough' - yeah. I suppose I thought... if I'm going to do it, may as well do it properly. (although I did leave in a few hundred very minor mistakes like its/it's etc. which are below even my threshold for worth correcting ;-)

@thnkslprpt thnkslprpt marked this pull request as ready for review September 2, 2021 07:09
@thnkslprpt
Copy link
Contributor Author

@astrogeco - The commit has been split into comments/docs/code as requested, and the additional typos that @ArielSAdamsNASA noticed have been incorporated.

@astrogeco astrogeco merged commit b843463 into nasa:main Sep 10, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Sep 10, 2021
astrogeco added a commit to astrogeco/osal that referenced this pull request Sep 11, 2021
Fix nasa#1147, Correct typos in documentation, print statements, and comments

Part of nasa/cFS#352
@astrogeco astrogeco changed the title Fixed typos in docs, comments and error message text. Fix #1147, Correct typos in documentation, print statements, and comments Sep 11, 2021
@astrogeco
Copy link
Contributor

Tested in astrogeco@2a2defb

Merged in 2a2defb

@thnkslprpt thnkslprpt deleted the FIX-OSAL-TYPOS branch September 11, 2021 07:37
@skliper skliper added this to the 6.0.0 milestone Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typos in documentation, print statements, and comments
5 participants