Skip to content

Hacktoberfest 2020 - Add typehints and default input for project_euler/problem_25 #2901

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

Merged
merged 8 commits into from
Oct 7, 2020

Conversation

nstoik
Copy link
Contributor

@nstoik nstoik commented Oct 6, 2020

Describe your change:

  • 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}.

Related: #2786

@nstoik
Copy link
Contributor Author

nstoik commented Oct 6, 2020

This PR addresses the issues mentioned in #2786(comment) in the directory for Project Euler Problem 25

I have a couple of things I want to confirm for this pull request. For sol1.py are the added docstrings to the functions good or is it redundant? And is it okay to edit the provided solution as well? I removed the check for int since the typehint now specifies it should be an int.

And for sol3.py I removed the unused variable to get rid of that warning.

I am happy to make any edits to the pull request as needed!

@dhruvmanila dhruvmanila added awaiting changes A maintainer has requested changes to this PR hacktoberfest-accepted Accepted to be counted towards Hacktoberfest labels Oct 6, 2020
Copy link
Member

@dhruvmanila dhruvmanila left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution!

@dhruvmanila dhruvmanila merged commit 4d4ce40 into TheAlgorithms:master Oct 7, 2020
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
…rithms#2901)

* add typehints and docstrings

* add typehint and default value

* add typehint and default value. Removed unused variable.

* do not modifiy the given solution

* add doctests

* update sol1 after running black

* add typehint, docstring, and doctest

* update sol2 after running black
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
…rithms#2901)

* add typehints and docstrings

* add typehint and default value

* add typehint and default value. Removed unused variable.

* do not modifiy the given solution

* add doctests

* update sol1 after running black

* add typehint, docstring, and doctest

* update sol2 after running black
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting changes A maintainer has requested changes to this PR hacktoberfest-accepted Accepted to be counted towards Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants