[Sweep Rules] Add docstring to searchRegions function in regionController.js #157
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 a docstring to the
searchRegions
function in theregionController.js
file. The function is located in thebackend/src/controllers
directory. The docstring provides a description of the function's purpose, information about its parameters, return value, and any exceptions it may raise. The docstring follows the format of the existing docstrings in the file as a guide.Summary of Changes
searchRegions
function inregionController.js
.Please review and merge this PR. Thank you!