"Add docstrings to all functions and file headers."
Description
This PR addresses the issue of missing docstrings in the GedcomExporter.php and GedcomImporter.php files located in the src/Commands directory. Docstrings have been added at the beginning of each file to describe the file's purpose and functionality. Additionally, each function within these files now has a docstring that explains what the function does, its parameters, and its return value.
Summary of Changes
Added a file-level docstring to src/Commands/GedcomExporter.php and src/Commands/GedcomImporter.php to describe the purpose and functionality of each file.
Added function-level docstrings to the __construct() and handle() methods in both GedcomExporter.php and GedcomImporter.php to describe the purpose, parameters, and return value of each function.
These changes enhance the readability of the code and provide clear documentation, making it easier for future developers to understand the purpose and functionality of these files and their functions.
PR Feedback (click)
I created this PR to address this rule:
"Add docstrings to all functions and file headers."
Description
This PR addresses the issue of missing docstrings in the
GedcomExporter.php
andGedcomImporter.php
files located in thesrc/Commands
directory. Docstrings have been added at the beginning of each file to describe the file's purpose and functionality. Additionally, each function within these files now has a docstring that explains what the function does, its parameters, and its return value.Summary of Changes
src/Commands/GedcomExporter.php
andsrc/Commands/GedcomImporter.php
to describe the purpose and functionality of each file.__construct()
andhandle()
methods in bothGedcomExporter.php
andGedcomImporter.php
to describe the purpose, parameters, and return value of each function.These changes enhance the readability of the code and provide clear documentation, making it easier for future developers to understand the purpose and functionality of these files and their functions.