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

adding JSDOCS for the following files BoyerMoore checkRearrangedPalin… #1650

Conversation

mohmmadAyesh
Copy link

…drome CheckPalindrome

Open in Gitpod know more

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • [ x] Documentation change?

Checklist:

  • [ x] I have read CONTRIBUTING.md.
  • [ x] This pull request is all my own work -- I have not plagiarized.
  • [ x] I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • [x ] All new JavaScript files are placed inside an existing directory.
  • [ x] All filenames should use the UpperCamelCase (PascalCase) style. There should be no spaces in filenames.
    Example:UserProfile.js is allowed but userprofile.js,Userprofile.js,user-Profile.js,userProfile.js are not
  • [ x] All new algorithms have a URL in their comments that points to Wikipedia or another similar explanation.
  • [ x] If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.
  • HI i tried to add JSDOCS to files missing it in String Folder this was part of solving issue chore: fix / clean up jsdoc comments #1342 `Fixes
    chore: fix / clean up jsdoc comments #1342

Copy link
Collaborator

@appgurueu appgurueu left a comment

Choose a reason for hiding this comment

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

  1. Please "batch" your "add doc comments" PRs in a single PR.
  2. Feel free to refactor obviously dirty code (such as returning error messages) rather than just documenting it. Also consider renaming parameters if it helps readability.
  3. Please try to keep redundant comments to a minimum. For example when you've already stated that a function "performs the Boyer-Moore string search algorithm to find a pattern in a given string", it is pretty self-explanatory that a parameter pattern of type string is "the pattern string to search for in the main string"

@mohmmadAyesh
Copy link
Author

mohmmadAyesh commented Mar 27, 2024

I ll try to combine batch all PRS into one after I fix and do your suggested changes and feedback I was thought It was good to seperate for every folder, Ill combine them later thanks for feedback

@mohmmadAyesh
Copy link
Author

this is branch is merged to PR-fix-docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants