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

Add suitable docstrings to the module, classes and functions #27

Closed
ankitaggarwal011 opened this issue Oct 6, 2016 · 7 comments
Closed

Comments

@ankitaggarwal011
Copy link
Owner

Please refer these links while constructing the suitable docstrings.

Any suggestions are welcome. Thanks.

@lostwarrior404
Copy link
Contributor

I'll try to work on this.Can you please explain the purpose/use of the function f(..) and cnn(..) inpycnn.py.

@ankitaggarwal011
Copy link
Owner Author

ankitaggarwal011 commented Oct 6, 2016

Thanks @lostwarrior404. I appreciate your help.

cnn function is the approximate sigmoidal kernel function for this neural network.

f(x, t, ...) computes the derivative of x at t.

iraquitan added a commit to iraquitan/PyCNN that referenced this issue Oct 8, 2016
Add Google Style Python Docstrings to the module, classes, and functions
of pycnn.py file.

Resolves ankitaggarwal011#27
@iraquitan
Copy link
Contributor

Adde PR#30 for this issue.

@ankitaggarwal011
Copy link
Owner Author

Excellent work @iraquitan, but @lostwarrior404 mentioned that he is working on this issue. I hope he didn't start working on it.
In the future, please comment on the issue that your working on to avoid any duplication. Thank you for your contribution.

@lostwarrior404, shall we go ahead with this? I hope you didn't start working on this yet.

@lostwarrior404
Copy link
Contributor

Please go ahead with it.Open source software is about community not about a single person.And @iraquitan has done a much better job than me.

@ankitaggarwal011
Copy link
Owner Author

@lostwarrior404, thanks for your good open source spirit.
Your contribution is appreciated. @iraquitan, please go ahead with this issue.

@iraquitan
Copy link
Contributor

Ok, I should've commented here before working. I'll do that next time. Thanks for comprehension @lostwarrior404 and @ankitaggarwal011.

@ankitaggarwal011 ankitaggarwal011 changed the title Add suitable docstrings to the module, classes and functions. Add suitable docstrings to the module, classes and functions Oct 8, 2016
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

3 participants