Python icon indicating copy to clipboard operation
Python copied to clipboard

Added Readme file to document the hashing algorithm.

Open pravinkori opened this issue 2 years ago • 1 comments

Describe your change:

Added description of hashing algorithm for better understanding.

  • [ ] 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.
  • [ ] All new Python files are placed inside an existing directory.
  • [x] All filenames are in all lowercase characters with no spaces or dashes.
  • [ ] All functions and variable names follow Python naming conventions.
  • [ ] All function parameters and return values are annotated with Python type hints.
  • [ ] All functions have doctests that pass the automated testing.
  • [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • [ ] If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

pravinkori avatar Oct 06 '22 05:10 pravinkori

@Kush1101 could you review the PR.

pravinkori avatar Oct 12 '22 06:10 pravinkori

@cclauss Looks good

CaedenPH avatar Oct 30 '22 10:10 CaedenPH