Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Improve documentation in various components #169

Open
ewenw opened this issue Aug 17, 2022 · 1 comment
Open

Improve documentation in various components #169

ewenw opened this issue Aug 17, 2022 · 1 comment
Assignees
@dywsjtu
Labels
documentation Improvements or additions to documentation

Comments

@ewenw
Copy link
Contributor

ewenw commented Aug 17, 2022

Description

Some code comments and docstrings should be added, especially for resource_manager.py, data_loader.py, client_manager.py, etc. Also, some model diagram on what each component would be helpful for people new to the codebase.
@ewenw ewenw added the documentation Improvements or additions to documentation label Aug 17, 2022
@fanlai0990
Copy link
Member

Thank you for this feedback. Can you @dywsjtu please work on this asap, which may involve code cleanup? Thanks!

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@dywsjtu dywsjtu

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ewenw @fanlai0990 @dywsjtu