The Wayback Machine - https://web.archive.org/web/20201007134549/https://github.com/TheAlgorithms/Python/issues/2786
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

Jump to bottom

[Project Euler] Algorithms do not follow coding styles #2786

Open
kalpanajangra opened this issue Oct 5, 2020 · 1 comment
Open

[Project Euler] Algorithms do not follow coding styles #2786

kalpanajangra opened this issue Oct 5, 2020 · 1 comment
Labels
enhancement good first issue hacktoberfest hacktoberfest-accepted help wanted

Comments

@kalpanajangra
Copy link

@kalpanajangra kalpanajangra commented Oct 5, 2020

Many algorithms in Project Euler do not follow coding styles as mentioned by @dhruvmanila here, or even the standard coding guidelines.

Notes:

  • A lot of inconsistencies with the solution functions (a lot of them aren't named as "solution")
  • docstring inconsistencies:
>```docstring```
vs
>```
docstring```

The following are considered to be bad and may be requested to be improved:
>>> x = x + 2	# increased by 2
This is too trivial. Comments are expected to be explanatory. For comments, you can write them above, on or below a line of code, as long as you are consistent within the same piece of code.

But there are places where this isn't practised.

Python/project_euler/problem_30/soln.py

Line 36 in b934da4

print(count) # --> 443839

The list isn't complete.
As a beginner who's looking to either understand/contribute, this makes it a bit difficult.
@dhruvmanila
Copy link
Member

@dhruvmanila dhruvmanila commented Oct 5, 2020 •
edited

This is a completely valid issue. The thing is:

  • Those initial solutions were submitted a long time ago
  • I don't think consistency was maintained back then

Now as the number of solutions is increasing we need to enforce some of the consistency. One of the main ones was as I mentioned in #2695 (comment) but as you said there are many more. We can start with this and fix one issue at a time.

Due to some of the solutions not containing solution() function or requires some number of positional arguments we have decided to skip this script for now which checks for the solutions for every problem present. We can start fixing this first and then move on to other issues mentioned.

Submit the fix for one directory at a time and once that is approved, submit another one.

These are the errors which need to be fixed before we can start running the script in our tests:
https://travis-ci.com/github/TheAlgorithms/Python/jobs/394777235#L240-L312

These two are the main messages to look for in the above log:

  1. solution() missing 1 required positional argument: 'n'
  2. module 'sol1.py' has no attribute 'solution'
  • The first one says that we have a solution() function but that requires a positional argument so to fix that put the default value for those parameters as the question input such that when we call the function without any arguments it returns the answer.
  • The second one says that the specific file doesn't contain any solution() function so we need to either add the function or change the name of the present function, which returns the answer, to solution() and if it takes any positional arguments, to do the same thing as mentioned in the first point.

Current Status:

  • problem_5/sol2.py: solution() missing 1 required positional argument: 'n'
  • problem_5/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_8/sol2.py: solution() missing 1 required positional argument: 'n'
  • problem_8/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_8/sol3.py: solution() missing 1 required positional argument: 'n'
  • problem_9/sol2.py: solution() missing 1 required positional argument: 'n'
  • problem_13/sol1.py: solution() missing 1 required positional argument: 'array'
  • problem_14/sol2.py: solution() missing 1 required positional argument: 'n'
  • problem_14/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_15/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_16/sol2.py: solution() missing 1 required positional argument: 'power'
  • problem_16/sol1.py: solution() missing 1 required positional argument: 'power'
  • problem_17/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_21/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_26/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_27/problem_27_sol1.py: solution() missing 2 required positional arguments: 'a_limit' and 'b_limit'
  • problem_31/sol2.py: solution() missing 1 required positional argument: 'pence'
  • problem_31/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_33/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_34/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_35/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_36/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_37/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_39/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_41/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_43/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_44/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_45/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_46/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_55/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_56/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_63/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_99/sol1.py: module 'sol1.py' has no attribute 'solution'
  • problem_234/sol1.py: solution() missing 1 required positional argument: 'n'
  • problem_551/sol1.py: solution() missing 1 required positional argument: 'n'
@dhruvmanila dhruvmanila mentioned this issue Oct 5, 2020
Open
0 of 2 tasks complete
kalpanajangra added a commit to kalpanajangra/Python that referenced this issue Oct 5, 2020
@kalpanajangra
Fixed Project Euler Problem 01: Fixes TheAlgorithms#2786
a46620c
@kalpanajangra kalpanajangra mentioned this issue Oct 5, 2020
Closed
11 of 14 tasks complete
bobluppes added a commit to bobluppes/Python that referenced this issue Oct 5, 2020
@bobluppes
Fixed coding style problem 33 fixes: TheAlgorithms#2786
3782829
@dhruvmanila dhruvmanila mentioned this issue Oct 5, 2020
Open
9 of 14 tasks complete
@archaengel archaengel mentioned this issue Oct 5, 2020
Merged
10 of 14 tasks complete
@CMeza99 CMeza99 mentioned this issue Oct 6, 2020
Closed
10 of 14 tasks complete
@nthall nthall mentioned this issue Oct 6, 2020
Merged
12 of 14 tasks complete
@archaengel archaengel mentioned this issue Oct 6, 2020
Merged
10 of 14 tasks complete
@CMeza99 CMeza99 mentioned this issue Oct 6, 2020
Open
10 of 14 tasks complete
@nstoik nstoik mentioned this issue Oct 6, 2020
Merged
11 of 14 tasks complete
@archaengel archaengel mentioned this issue Oct 6, 2020
Merged
10 of 14 tasks complete
@vovapi vovapi mentioned this issue Oct 6, 2020
Merged
11 of 14 tasks complete
@archaengel archaengel mentioned this issue Oct 6, 2020
Merged
11 of 14 tasks complete
@nthall nthall mentioned this issue Oct 6, 2020
Merged
10 of 14 tasks complete
@agirones agirones mentioned this issue Oct 6, 2020
Closed
11 of 14 tasks complete
@dhruvmanila dhruvmanila mentioned this issue Oct 7, 2020
Merged
4 of 4 tasks complete
@nstoik nstoik mentioned this issue Oct 7, 2020
Open
12 of 14 tasks complete
This was referenced Oct 7, 2020
Merged
Open
@JasirZaeem JasirZaeem mentioned this issue Oct 7, 2020
Merged
7 of 7 tasks complete
dhruvmanila added a commit that referenced this issue Oct 7, 2020
@JoanRosell @dhruvmanila
Address #2786 - Fix code style in Project Euler Problem 76 (#2978)
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…
c14cfa3 
* fix code style in problem 76

Signed-off-by: joan.rosellr <joan.rosellr@gmail.com>

* Update sol1.py

* Update sol1.py

* Remove trailing whitespace

Co-authored-by: Dhruv <dhruvmanila@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue hacktoberfest hacktoberfest-accepted help wanted
2 participants
@dhruvmanila @kalpanajangra
You can’t perform that action at this time.