python-mini-project icon indicating copy to clipboard operation
python-mini-project copied to clipboard

Published 20 hours ago • verified publisher icon ndleah

Add Docstring in the Caesar Cipher file

Open Gabriela20103967 opened this issue 8 months ago • 0 comments

Description

In this issue, I want to add docstrings to the function in the Caesar Cipher code. The purpose is to have a clear and well documented code that will help us to understand it better.

Type of issue

  • [ ] Feature (New Script)
  • [ ] Bug
  • [x] Documentation

Checklist:

  • [ ] I have read the project guidelines.
  • [x] I have checked previous issues to avoid duplicates.
  • [ ] This issue will be meaningful for the project.

Details

The functions in the Caesar Cipher code currently lack docstrings. We need to add detailed docstrings to explain:

  • The purpose of each function.
  • The parameters each function, including their types and descriptions.
  • The return values, including their types and descriptions.

Gabriela20103967 avatar Jun 07 '24 08:06 Gabriela20103967