Skip to content

Added Readme file to document the hashing algorithm.#6743

Merged
cclauss merged 3 commits intoTheAlgorithms:masterfrom
pravinkori:master
Oct 30, 2022
Merged

Added Readme file to document the hashing algorithm.#6743
cclauss merged 3 commits intoTheAlgorithms:masterfrom
pravinkori:master

Conversation

@pravinkori
Copy link
Copy Markdown
Contributor

@pravinkori pravinkori commented Oct 6, 2022

Describe your change:

Added description of hashing algorithm for better understanding.

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

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • 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.
  • 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}.

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files labels Oct 6, 2022
@pravinkori
Copy link
Copy Markdown
Contributor Author

pravinkori commented Oct 12, 2022

@Kush1101 could you review the PR.

@CaedenPH
Copy link
Copy Markdown
Contributor

CaedenPH commented Oct 30, 2022

@cclauss Looks good

cclauss
cclauss approved these changes Oct 30, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

RSLGTM

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 30, 2022
@cclauss cclauss merged commit cc42300 into TheAlgorithms:master Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cclauss cclauss cclauss approved these changes

@CaedenPH CaedenPH CaedenPH approved these changes

Assignees

No one assigned

Labels

documentation This PR modified documentation files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pravinkori @CaedenPH @cclauss