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

Refactoring - Break complex methods #12

Closed
Tracked by #3
miroslavpojer opened this issue May 21, 2024 · 1 comment
Closed
Tracked by #3

Refactoring - Break complex methods #12

miroslavpojer opened this issue May 21, 2024 · 1 comment
Assignees
Labels
refactoring Improving code quality, paying off tech debt, aligning APIs

Comments

@miroslavpojer
Copy link
Collaborator

miroslavpojer commented May 21, 2024

def main():
    data = "My data read from the Web"
    print(data)

if __name__ == "__main__":
    main()
@MobiTikula
Copy link
Collaborator

MobiTikula commented Sep 2, 2024

This issue was originally made during the first phase of migrating the POC from script based into OOP solution: #3. For the current POC state, this issue is outdated. All the points were solved during the development, mainly by implementing OOP and suggestions from the Pylint tool.

Outdated points:

  • break down complex long methods into several smaller ones, that are atomic

  • done with migrating into OOP

  • refactor consolidate_features_with_project() as it is suggested in: https://github.com/AbsaOSS/living-doc-generator/pull/2/files#r1603412467

  • not having this method anymore, since we put all the logic into one generator.py file

  • make some methods more general and add them to utils folder

  • we made a utils folder, where we have multiple helping scripts such as: constants, decorators, utils etc.

  • main method pattern refactoring with best practice (via https://realpython.com/python-main-function/)

  • it is done by putting all the logic into one generator.py file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Improving code quality, paying off tech debt, aligning APIs
Projects
None yet
Development

No branches or pull requests

2 participants