"Add docstrings to all functions and file headers."
Description
This PR adds docstrings to all functions in the GedcomParserTest.php and ImporterTests.php files. The docstrings provide a clear description of each function's role, its parameters, and its return value, adhering to the project's coding standards.
The docstrings follow the format and style used in the GedcomExporterTest.php file, which includes a brief description of the function, followed by annotations for parameters (@param) and the return value (@return), if applicable.
Summary of Changes
Added docstrings to the testParseIndividualRecords, testParseFamilyRecords, testParseNotes, and testParseMediaObjects functions in GedcomParserTest.php.
Added docstrings to the testNoteImport, testObjeImport, and testRepoImport functions in ImporterTests.php.
These changes improve the readability of the code and make it easier for future developers to understand the purpose and usage of these functions.
PR Feedback (click)
I created this PR to address this rule:
"Add docstrings to all functions and file headers."
Description
This PR adds docstrings to all functions in the
GedcomParserTest.php
andImporterTests.php
files. The docstrings provide a clear description of each function's role, its parameters, and its return value, adhering to the project's coding standards.The docstrings follow the format and style used in the
GedcomExporterTest.php
file, which includes a brief description of the function, followed by annotations for parameters (@param
) and the return value (@return
), if applicable.Summary of Changes
testParseIndividualRecords
,testParseFamilyRecords
,testParseNotes
, andtestParseMediaObjects
functions inGedcomParserTest.php
.testNoteImport
,testObjeImport
, andtestRepoImport
functions inImporterTests.php
.These changes improve the readability of the code and make it easier for future developers to understand the purpose and usage of these functions.