Skip to content

Improve code comments and add docstrings for better readability (good first issue) #95

Description

@GitByG4v

As a beginner, a good first issue could be to improve the formatting and add comments to the code in the project for better readability and understanding. Beginners can pick any module and add explanatory comments above functions or classes where documentation is scarce. This makes it easier for future contributors to learn and maintain the code. No breaking changes are needed.

Example tasks:

  • Locate a module lacking comments (for example, views.py or models.py).
  • Add helpful comments and docstrings to classes and functions.
  • Ensure PEP8 compliance for style.

Code reference: Pick any file such as todo/views.py and look for functions that could use more comments. For example:

# Existing code without much explanation
def task_list(request):
    tasks = Task.objects.all()
    return render(request, 'todo/task_list.html', {'tasks': tasks})

Add comments like:

# View to list all tasks for the current user
def task_list(request):
    # Retrieves all Task objects from the database
    tasks = Task.objects.all()
    # Renders the task_list.html template with the fetched tasks
    return render(request, 'todo/task_list.html', {'tasks': tasks})

You can choose any function or class throughout the repo that could be improved in this way.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions