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

Add numpy-style docstrings to code #6

Closed
jatkinson1000 opened this issue Feb 19, 2024 · 3 comments
Closed

Add numpy-style docstrings to code #6

jatkinson1000 opened this issue Feb 19, 2024 · 3 comments
Assignees
@surbhigoel77
Labels
documentation Improvements or additions to documentation Python-repo Part of the python NN repo

Comments

@jatkinson1000
Copy link
Member

jatkinson1000 commented Feb 19, 2024 •
edited by surbhigoel77
Loading

Links #19

The code is currently lacking docstrings, making its understanding difficult.

These should be added (perhaps once it is in a better refactored state see #5).

I suggest using the numpy format.
@jatkinson1000 jatkinson1000 added documentation Improvements or additions to documentation Python-repo Part of the python NN repo labels Feb 19, 2024
@surbhigoel77 surbhigoel77 self-assigned this Mar 4, 2024
@surbhigoel77 surbhigoel77 changed the title Add docstrings to code Add numpy-style docstrings to code Mar 17, 2024
@jatkinson1000 jatkinson1000 mentioned this issue Mar 18, 2024
Merged
12 tasks
@omarjamil
Copy link
Member

@surbhigoel77 can this be closed?

@surbhigoel77
Copy link
Collaborator

@surbhigoel77 can this be closed?

I think so @omarjamil. Our in-progress work on the python code contains only numpy-style doctstrings now.

@surbhigoel77
Copy link
Collaborator

Numpy-style docstrings added to the latest version of work.

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

@surbhigoel77 surbhigoel77

Labels
documentation Improvements or additions to documentation Python-repo Part of the python NN repo
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@omarjamil @surbhigoel77 @jatkinson1000