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.

Sign up for GitHub

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

Jump to bottom

Code Readability Overhaul #9

Open
Camaendir opened this issue Oct 1, 2020 · 4 comments
Open

Code Readability Overhaul #9

Camaendir opened this issue Oct 1, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest
Milestone
Version 2.0

Comments

@Camaendir
Copy link
Owner

Camaendir commented Oct 1, 2020 •
edited
Loading

The code needs to be overhauled and patched up with comments to allow easier refractoring and updates.
@Camaendir Camaendir added documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest labels Oct 1, 2020
@Camaendir Camaendir added this to the Version 2.0 milestone Oct 2, 2020
@Camaendir Camaendir mentioned this issue Oct 2, 2020
Merged
@NitinShaily
Copy link

hey can I help?

@Camaendir
Copy link
Owner Author

Sure, you can just make a pull request. If you have any further questions: feel free to ask.

@NitinShaily
Copy link

which code file should i excatly fill with comments?..

@Camaendir
Copy link
Owner Author

Code Readability in this case not only refers to adding comments, but also to overhaul some functions. Because some functions were written hastily to have a working prototype some parts need to be cleaned up and then pinned with comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest
Projects
None yet
Milestone
Version 2.0
Development

No branches or pull requests
2 participants
@Camaendir @NitinShaily