Skip to content

/ Python

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

Naive string doctests + typehints #2054

Merged
merged 9 commits into from Jun 1, 2020
Merged

Naive string doctests + typehints #2054

merged 9 commits into from Jun 1, 2020

Conversation

@mateuszz0000
Copy link
Member

mateuszz0000 commented Jun 1, 2020

Describe your change:

Added doctests to naive pattern search algorithm.

  • 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}.
mateuszz0000 added 2 commits Jun 1, 2020
@mateuszz0000
Added doctests
03f11bb
@mateuszz0000
Added __main__
Loading status checks…
6f9f086
@cclauss
cclauss reviewed Jun 1, 2020
View changes
strings/naive_string_search.py Outdated Show resolved Hide resolved
@cclauss
Copy link
Member

cclauss commented Jun 1, 2020 •
edited

I would be happier to see this as two separate pull requests. The first should put tests and type hints in place. Once the first lands, the second could rewrite the algorithm. Doing both in one PR confuses the reviewer.
@mateuszz0000
Commit suggestion
Loading status checks…
5994d73
@mateuszz0000
Copy link
Member Author

mateuszz0000 commented Jun 1, 2020

Hmm ok. Should I close this PR or do it next time?
@cclauss
Copy link
Member

cclauss commented Jun 1, 2020

In this PR, just undo the changes to the algorithm itself but keep the type hints and doctests.
@mateuszz0000
Undo changes to keep only doctests and typehints
Loading status checks…
0188e28
@mateuszz0000 mateuszz0000 requested a review from cclauss Jun 1, 2020
@cclauss
cclauss reviewed Jun 1, 2020
View changes
strings/naive_string_search.py Outdated Show resolved Hide resolved
mateuszz0000 and others added 3 commits Jun 1, 2020
@mateuszz0000
Reundo function name with params
Loading status checks…
63f0a97
@cclauss
Update naive_string_search.py
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
328991a
@cclauss
Update naive_string_search.py
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
ff4bb9c
@cclauss
cclauss approved these changes Jun 1, 2020
View changes
cclauss added 2 commits Jun 1, 2020
@cclauss
Update naive_string_search.py
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
a9c3ac2
@cclauss
Update naive_string_search.py
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
cb70287
@cclauss cclauss merged commit 1a25446 into TheAlgorithms:master Jun 1, 2020
2 checks passed
2 checks passed
codespell
Details
Travis CI - Pull Request Build Passed
Details
@cclauss
Copy link
Member

cclauss commented Jun 1, 2020

Thanks for doing this!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
@mateuszz0000 @cclauss
You can’t perform that action at this time.