kelproject / kelproject/kel-api

Missing docstrings

Open
#8 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
36
Forks
8
PR merge metrics
No merged PRs in 30d

Description

I don't know if it is meant to be, but the codebase is not PEP-8 compliant because any of the classes provides a docstring.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, classes, or tests are named. Start by reviewing the Django/Pinax codebase and inventorying classes without docstrings. Done means the intended classes have clear docstrings and the project’s expectations for documentation are satisfied.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
backend, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.