fixing JSDOCS for Sorts Folder the folder that been modified are Alph… #1649
Conversation
This file contains 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
…aNumerical,BeadSort,BogoSort,BubbleSort,CocktailShakerSort,CountinfSort,FindSecondsLargestElementSort,FisherYatesShuffle
appgurueu
reviewed
Mar 27, 2024
Sorts/BeadSort.js
Outdated
| @@ -7,6 +7,9 @@ | |||
| * NOTE: It only works for arrays of positive integers. | |||
| * | |||
| * Wikipedia: https://en.wikipedia.org/wiki/Bead_sort | |||
| * @param {number[]} sequence An array of positive integers to be sorted using Bead Sort. | |||
There was a problem hiding this comment.
The "using Bead Sort" is not helpful here or in the next line.
Sorts/BogoSort.js
Outdated
| @@ -1,5 +1,7 @@ | |||
| /** | |||
| * Checks whether the given array is sorted in ascending order. | |||
| * @param {number[]} array The array to be checked for sorted order. | |||
There was a problem hiding this comment.
number[] is wrong. Any comparable objects are fine. (Strings would be fine as well, for example, though the order may not be what you expect.)
The comments are also a bit redundant. You're effectively stating the same thing three times.
Sorts/BogoSort.js
Outdated
| @@ -13,6 +15,7 @@ export function isSorted(array) { | |||
|
|
|||
| /** | |||
| * Shuffles the given array randomly in place. | |||
| * @param {any[]} array The array to be shuffled. | |||
There was a problem hiding this comment.
How does this comment help?
Sorts/BubbleSort.js
Outdated
| @@ -42,6 +44,8 @@ export function bubbleSort(items) { | |||
|
|
|||
| /** | |||
| * Using a while loop and a for loop. | |||
| * @param {number[]} arr The array to be sorted. | |||
There was a problem hiding this comment.
Note that the array is sorted in-place.
Sorts/CocktailShakerSort.js
Outdated
| @@ -7,6 +7,9 @@ | |||
| * | |||
| * Wikipedia (Cocktail Shaker Sort): https://en.wikipedia.org/wiki/Cocktail_shaker_sort | |||
| * Wikipedia (Bubble Sort): https://en.wikipedia.org/wiki/Bubble_sort | |||
| * | |||
| * @param {number[]} items The array of numbers to be sorted. | |||
There was a problem hiding this comment.
Again, please note that the sorting is in-place
Sorts/FisherYatesShuffle.js
Outdated
| @@ -1,3 +1,8 @@ | |||
| /** | |||
| * Shuffles the elements of the given array randomly in place. | |||
There was a problem hiding this comment.
Again you only really need one of the comments.
|
This branch merged with fix-docs |
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.
…aNumerical,BeadSort,BogoSort,BubbleSort,CocktailShakerSort,CountinfSort,FindSecondsLargestElementSort,FisherYatesShuffle
Describe your change:
Checklist:
Example:
UserProfile.jsis allowed butuserprofile.js,Userprofile.js,user-Profile.js,userProfile.jsare notFixes: #{$ISSUE_NO}.Hi I added JSDOCS to Files that missing it in Sorts Folder this is a part of solving issue chore: fix / clean up jsdoc comments #1342
Fixes:#{1342}Hope you accept it