Update output.js #180
Open
Update output.js #180
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
added consistent function header comments to output.js
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
added consistent function header comments to output.js
name: Pull request template
about: GenderMag Recorders Assistant project
What does this implementation fix? Explain your changes.
Standardizes and adds consistent function headers to every function in output.js. The comments follow the format used throughout the rest of the codebase, and help clarify arguments, return types, and the purpose of each function.
Does this close any open issue? (Give issue id from issue tracker)
Addresses issue Clean up output.js file #161 but does not close. There is more work to be done.
Include any related logs, error, output file etc.
No logs or errors were generated. All changes were purely to inline code comments and function headers.
Did you test on Mac and Windows?
Tested on Mac.
Did you test the full GM process and verify that the code does not contribute any unexpected errors/bugs?
Since no code logic was changed, no errors or bugs are expected.
Did you follow the style guidelines and verify that the code does not have any incorrect formatting?
Yes. The added comments match the existing style for header comments and do not introduce any formatting issues.
Any other information?
My first open source contribution, plan to close issue Clean up output.js file #161 in the near future.