Add Docstrings to Functions and File Headers in getContextsMQR.ts #83
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.
PR Feedback (click)
I created this PR to address this rule:
"Add docstrings to all functions and file headers."
Description
This PR adds docstrings to the function and file headers in the file
src/pages/api/getContextsMQR.ts
. The docstrings provide a brief description of what the function does, its parameters, and its return value. The file header provides a brief description of the purpose of the file.Summary of Changes
src/pages/api/getContextsMQR.ts
that describes the purpose of the file.fetchMQRContexts
in the filesrc/pages/api/getContextsMQR.ts
. The docstring describes the purpose of the function, its parameters, and its return value.