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

Code Clean Up and Structure Updates #150

Open
dadamsncsa opened this issue Feb 16, 2021 · 0 comments
Open

Code Clean Up and Structure Updates #150

dadamsncsa opened this issue Feb 16, 2021 · 0 comments

Comments

@dadamsncsa
Copy link
Member

Summary

  • Break up large monilithic source files into packages and modules
    • Start with packages for each major large file in src/gresq/dashboard: query, submit, recipe, stats oscm
  • Identify key functions and methods that need documentation and testing
  • Add google style docstrings to modules classes and methods with the following priority:
    1. Modules
    2. Classes
    3. Key Functions and Methods
      4 Other functions and methods
  • Move re-usable code to src/gres/util
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant