Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docstring in the Caesar Cipher file #270

Open
2 of 6 tasks
Gabriela20103967 opened this issue Jun 7, 2024 · 0 comments · May be fixed by #272
Open
2 of 6 tasks

Add Docstring in the Caesar Cipher file #270

Gabriela20103967 opened this issue Jun 7, 2024 · 0 comments · May be fixed by #272

Comments

@Gabriela20103967
Copy link

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.
@Gabriela20103967 Gabriela20103967 changed the title Add Docstring in the Caesar Cipher file and update the Readme file Add Docstring in the Caesar Cipher file Jun 9, 2024
@Gabriela20103967 Gabriela20103967 linked a pull request Jun 9, 2024 that will close this issue
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant