Fix style of the first ten solutions for Project Euler (#3242)

* Fix style of the first ten solutions for Project Euler

- Unify the header docstring, and add reference URLs to wikipedia
  or similar
- Fix docstrings to be properly multilined
- Add newlines where appropriate
- Add doctests where they were missing
- Remove doctests that test for the correct solution
- fix obvious spelling or grammar mistakes in comments and
  exception messages
- Fix line endings to be UNIX. This makes two of the files seem
  to have changed completely
- no functional changes in any of the solutions were done
  (except for the spelling fixes mentioned above)

* Fix docstrings and main function as per Style Guide
This commit is contained in:
Michael D
2020-10-25 04:23:16 +01:00
committed by GitHub
parent 5be77f33f7
commit 98e9d6bdb6
35 changed files with 717 additions and 469 deletions

View File

@ -1,19 +1,25 @@
"""
Problem:
Each new term in the Fibonacci sequence is generated by adding the previous two
terms. By starting with 1 and 2, the first 10 terms will be:
Project Euler Problem 2: https://projecteuler.net/problem=2
1,2,3,5,8,13,21,34,55,89,..
Even Fibonacci Numbers
Each new term in the Fibonacci sequence is generated by adding the previous
two terms. By starting with 1 and 2, the first 10 terms will be:
1, 2, 3, 5, 8, 13, 21, 34, 55, 89, ...
By considering the terms in the Fibonacci sequence whose values do not exceed
n, find the sum of the even-valued terms. e.g. for n=10, we have {2,8}, sum is
10.
four million, find the sum of the even-valued terms.
References:
- https://en.wikipedia.org/wiki/Fibonacci_number
"""
def solution(n: int = 4000000) -> int:
"""Returns the sum of all fibonacci sequence even elements that are lower
or equals to n.
"""
Returns the sum of all even fibonacci sequence elements that are lower
or equal to n.
>>> solution(10)
10
@ -26,6 +32,7 @@ def solution(n: int = 4000000) -> int:
>>> solution(34)
44
"""
i = 1
j = 2
total = 0
@ -38,4 +45,4 @@ def solution(n: int = 4000000) -> int:
if __name__ == "__main__":
print(solution(int(input().strip())))
print(f"{solution() = }")