Skip to content

Add Docstring in the Caesar Cipher file  #270

Description

@Gabriela20103967

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
  • Documentation

Checklist:

  • I have read the project guidelines.
  • 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.

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