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

Function docstrings are missing #1523

Open
AnshulMalik opened this issue Sep 7, 2017 · 2 comments
Open

Function docstrings are missing #1523

AnshulMalik opened this issue Sep 7, 2017 · 2 comments

Comments

@AnshulMalik
Copy link
Member

AnshulMalik commented Sep 7, 2017

Issue type: Feature request (Infrastructure)

Description

Docstrings are used to explain what a module or function does, what are the parameters etc.
All modules should normally have docstrings, and all functions and classes exported by a module should also have docstrings.

Moreover it'll help new developers to get familiar with the code quickly.

One can pick functions one by one which he/she is familiar with, also this is a parent issue, so please don't say closes '1523'

@palash25
Copy link

I would like to work on this. It would speed up the process if you could direct me to a file that you want the docstrings added in or some resources to study about the workings of loklak (if not possible then I can try to understand it on my own). Or should I just pick any file of my choice and start working on it?

@singhpratyush
Copy link
Member

@palash25: You can proceed with your choice of package and add docstrings. Please also take a look at checkstyle issues for that file and correct them accordingly.

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

No branches or pull requests

5 participants