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

documentation and commenting #41

Open
anjalisoni3655 opened this issue Apr 13, 2021 · 10 comments
Open

documentation and commenting #41

anjalisoni3655 opened this issue Apr 13, 2021 · 10 comments
Assignees
Labels
Retrospective Contribute for Retro Sprint

Comments

@anjalisoni3655
Copy link
Collaborator

  • Documentation can be improved both for Readme as well as Wiki,
  • In Wiki, we can provide the logic of each of the ML Models that we have for the conversions.
  • We should also add more comments to each of the functions
@DebugAgrawal DebugAgrawal added the Retrospective Contribute for Retro Sprint label Apr 13, 2021
@imabp
Copy link
Contributor

imabp commented Apr 16, 2021

Hello @anjalisoni3655 and @DebugAgrawal
I feel I can contribute to readme. Let me know, if you assign this to me

@anjalisoni3655
Copy link
Collaborator Author

Hello @anjalisoni3655 and @DebugAgrawal
I feel I can contribute to readme. Let me know, if you assign this to me

Yah sure! Good to know that.

@imabp
Copy link
Contributor

imabp commented Apr 16, 2021

@anjalisoni3655 May I know, who all are the maintainers of the project
You Deepak and ?

@anjalisoni3655
Copy link
Collaborator Author

@anjalisoni3655 May I know, who all are the maintainers of the project
You Deepak and ?

Prashi, Bushra and Yvon

@imabp
Copy link
Contributor

imabp commented Apr 16, 2021

Just a crosscheck @anjalisoni3655 so i dont miss anything
@anjalisoni3655
@prashi23
@DebugAgrawal
@codingbug671
@yvonmanzi

Are all the maintainers and admins of this project ! right

@imabp imabp mentioned this issue Apr 16, 2021
@imabp
Copy link
Contributor

imabp commented Apr 16, 2021

@DebugAgrawal @anjalisoni3655
Please review the readme,
You can see the readme preview from my branch here
https://github.com/imabp/Code-Kindle/tree/docs-revamp#readme

@imabp
Copy link
Contributor

imabp commented Apr 16, 2021

Do let me know, if any changes needed
FYI: I have not removed, any part, just gave nicer headings. :)

@anjalisoni3655
Copy link
Collaborator Author

Do let me know, if any changes needed
FYI: I have not removed, any part, just gave nicer headings. :)

Hey, added comments in your PR, and also are you working on adding comments in the code?

@imabp
Copy link
Contributor

imabp commented Apr 16, 2021

For Comments I will make a different PR from different branch @anjalisoni3655

@imabp
Copy link
Contributor

imabp commented Apr 17, 2021

Code Commenting taking a bit time :)
Expect a PR by end of this weekend

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Retrospective Contribute for Retro Sprint
Projects
None yet
Development

No branches or pull requests

3 participants