MLH-Fellowship / MLH-Fellowship/orientation-project-python-24.FAL.A

Update docstrings to include more detail

Open
#9 1 comment 0 reactions 1 assignee View on GitHub

@David-OC17 is already working on this.

Since Sep 18, 2024.

bug good first issue
Dominant language
Python
Stars
1
Forks
10
No merged PRs in 30d

Description

Each function will require a docstring. Existing functions with docstrings currently don't explain what the function should do. Update these to include parameters and return statements where necessary.

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.