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

enhance docstrings in the Caesar Cipher #270

Open Gabriela20103967 opened this issue 8 months ago • 0 comments

Description

This pull request updates the docstrings and documentation for the Caesar Cipher project. It ensures that all methods are well-documented and easy to understand.

A short summary of what is included in your Pull Request.

Fixes #270

  • [x] Issue_no: <270>
  • [ ] Not applicable

Type of change

Choosing one or more options from the following as per the nature of your Pull request.

  • [ ] New project insert
  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [x] Documentation Update

Project

  • Project Name: Caesar Cipher

Checklist:

Please tick all the boxes that are fulfilled by your Pull Request.

  • [ ] I have named my files and folder, according to this project's guidelines.
  • [ ] My code follows the style guidelines of this project.
  • [x] I have commented on my code, particularly in hard-to-understand areas.
  • [ ] I have created a helpful and easy to understand README.md, according to the given README_TEMPLATE.
  • [ ] My changes do not produce any warnings.

Gabriela20103967 avatar Jun 09 '24 08:06 Gabriela20103967