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

Improve in-code commentaries #450

Open
ondratra opened this issue Jul 14, 2021 · 0 comments
Open

Improve in-code commentaries #450

ondratra opened this issue Jul 14, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation low-prio

Comments

@ondratra
Copy link
Contributor

There is a general lack of in-code commentaries in Hydra packages. For some parts, it's hard to understand the reasoning behind the mechanism that brings unnecessary burden, especially when refactoring the code.

Let's improve in-code commentaries by adding a short description to all classes and functions. Later on, we can add commentaries to function bodies.

@ondratra ondratra added the documentation Improvements or additions to documentation label Jul 14, 2021
@ondratra ondratra self-assigned this Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation low-prio
Projects
None yet
Development

No branches or pull requests

2 participants