Skip to content
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

[general need] V2 Codes Cleanup #191

Closed
servoz opened this issue May 14, 2021 · 2 comments
Closed

[general need] V2 Codes Cleanup #191

servoz opened this issue May 14, 2021 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@servoz
Copy link
Contributor

servoz commented May 14, 2021

We have started to comment on them (by chance from working on something else 794fe57) but they should be deleted properly. It's not a priority, but it should be done one of these days!

@servoz servoz added the enhancement New feature or request label May 14, 2021
@servoz servoz changed the title There are parts of the code that are no longer used in V2 [general need] There are parts of the code that are no longer used in V2 Aug 23, 2021
@servoz servoz assigned servoz and unassigned servoz Dec 8, 2021
@servoz servoz self-assigned this Mar 8, 2022
@servoz
Copy link
Contributor Author

servoz commented Mar 8, 2022

I will start working on this ticket. I think the purpose of this one goes far beyond removing the parts that are no longer used in V2. I'm changing the title of this ticket right away to the more general title "V2 Code Cleanup".

I think the goals of this ticket are:

  • Remove the parts of code that are not used anymore.
  • Remove commented code parts, when it is clearly not a comment that can be used in a future planned modification.
  • Add missing docstrings (functions, methods, classes, modules). For class, indicate the methods present in the class and their signature. For modules, indicate the classes present. Arrange, when possible, in alphabetical order (it's very time consuming to do, but let's not forget that our codes are first made to be read...)
  • Respect the code writing standards (especially pep 8).

Let me know if I forget something.

@servoz servoz changed the title [general need] There are parts of the code that are no longer used in V2 [general need] V2 Code Cleanup Mar 8, 2022
@servoz servoz changed the title [general need] V2 Code Cleanup [general need] V2 Codes Cleanup Mar 8, 2022
servoz added a commit that referenced this issue Mar 10, 2022
servoz added a commit that referenced this issue Mar 10, 2022
servoz added a commit that referenced this issue Mar 11, 2022
servoz added a commit that referenced this issue Mar 11, 2022
servoz added a commit that referenced this issue Mar 30, 2022
servoz added a commit that referenced this issue Apr 22, 2022
    - __init__.py
    - utils.py
servoz added a commit that referenced this issue Sep 19, 2022
servoz added a commit that referenced this issue Sep 19, 2022
servoz added a commit that referenced this issue Sep 19, 2022
servoz added a commit that referenced this issue Sep 19, 2022
servoz added a commit that referenced this issue Sep 19, 2022
servoz added a commit that referenced this issue Sep 19, 2022
    - __init__.py
    - utils.py
@servoz
Copy link
Contributor Author

servoz commented Mar 15, 2023

After a big effort, I think we can now close this ticket, the cleanup is now done, as far as possible ...

Special attention has been paid to the docstring. Most of it is up to date. I admit I put ""Blabla"" a few times by laziness or lack of time... We can always do a search on Blabla and fix it later, when we have some time...

All UTs work correctly now and the codes match them with a minimum of exceptions (for example, for Flake8, only C901 and W503 which are almost impossible to meet).

There is only one issue with isort that I could not fix. One can, while waiting to solve this problem, live with it by running isort locally and commenting in .pre-commit-config.yaml file before pushing to GitHub.

@servoz servoz closed this as completed Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant