Skip to content

Hacktoberfest 2020: Add typehints and default argument for project_euler/problem_01 - #2891

Merged
dhruvmanila merged 1 commit into
TheAlgorithms:masterfrom
archaengel:master
Oct 6, 2020
Merged

Hacktoberfest 2020: Add typehints and default argument for project_euler/problem_01#2891
dhruvmanila merged 1 commit into
TheAlgorithms:masterfrom
archaengel:master

Conversation

@archaengel

@archaengelarchaengel commented Oct 5, 2020

Copy link
Copy Markdown
Contributor

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

@archaengelarchaengel changed the title Hacktoberfest: Add typehints and default argument for project_euler/problem_01Hacktoberfest 2020: Add typehints and default argument for project_euler/problem_01Oct 5, 2020
@archaengel

Copy link
Copy Markdown
ContributorAuthor

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

@drts01

drts01 commented Oct 6, 2020

Copy link
Copy Markdown
Contributor

A default of a 1000 seems arbitrary and, to me, would be "unexpected" behavior, if the function was used in a program.

Also, why not squash the commits?

@archaengel

archaengel commented Oct 6, 2020

Copy link
Copy Markdown
ContributorAuthor

@CMeza99 I definitely see how 1000 seems like an arbitrary default. Unless I misunderstand, the project_euler directory is meant to provide solutions to the corresponding problems from the Project Euler site.

Problem 01 specifically mentions 1000 in the problem statement, and is in line with the implementation of the validation script which tests against the expected values in project_euler_answers.json, and the suggested improvements mentioned in #2786(comment).

I think it makes sense to squash these commits.

Squashed commit of the following:
commit 6801d07
Author: Archaengel <god11341258@gmail.com>
Date: Mon Oct 5 16:40:10 2020 -0700
Fix typehints in project_euler/problem01
commit 29afc3a
Author: Archaengel <god11341258@gmail.com>
Date: Mon Oct 5 15:06:34 2020 -0700
Add typehints and default argument for project_euler/problem_01
@dhruvmaniladhruvmanila added the hacktoberfest-accepted Accepted to be counted towards Hacktoberfest label Oct 6, 2020

@dhruvmaniladhruvmanila left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is perfect! Thank you for doing this.

@dhruvmanila
dhruvmanila merged commit edf2cd2 into TheAlgorithms:masterOct 6, 2020
@dhruvmanila

Copy link
Copy Markdown
Member

Also @archaengel please don't squash your commits as it will be done by us when we merge them. It is unnecessary on your end to do it.

@CMeza99 Please refer #2786

@archaengel

Copy link
Copy Markdown
ContributorAuthor

@dhruvmanila Gotcha, I'll keep that in mind. Thanks for the review!

@dhruvmaniladhruvmanila mentioned this pull request Oct 6, 2020
14 tasks
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
Squashed commit of the following:
commit 6801d07
Author: Archaengel <god11341258@gmail.com>
Date: Mon Oct 5 16:40:10 2020 -0700
Fix typehints in project_euler/problem01
commit 29afc3a
Author: Archaengel <god11341258@gmail.com>
Date: Mon Oct 5 15:06:34 2020 -0700
Add typehints and default argument for project_euler/problem_01
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
Squashed commit of the following:
commit 6801d07
Author: Archaengel <god11341258@gmail.com>
Date: Mon Oct 5 16:40:10 2020 -0700
Fix typehints in project_euler/problem01
commit 29afc3a
Author: Archaengel <god11341258@gmail.com>
Date: Mon Oct 5 15:06:34 2020 -0700
Add typehints and default argument for project_euler/problem_01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hacktoberfest-acceptedAccepted to be counted towards Hacktoberfest

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@archaengel@drts01@dhruvmanila