Add Docstrings to tests/WriterTest.php

PR Feedback (click)

[ ] 👍 Sweep Did Well
[ ] 👎 Sweep Needs Improvement
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 tests/WriterTest.php file. Docstrings have been added to the file header and each function within the file, following the PHPDoc standards. These docstrings provide a brief explanation of the purpose and functionality of the file and each function, improving code readability and maintainability.

Summary of Changes

Added a file header docstring to tests/WriterTest.php explaining the purpose and functionality of the file.
Added docstrings to the following functions:
- testConvertWithMultipleFamProperties: Explains the purpose of the test, its inputs, outputs, and the specific functionality it verifies.
- testConvertWithCustomFormat: Describes the test's goal of verifying the correct application of custom formats during the conversion process.
- testConvertWithSubnProperty: Details the test's purpose of checking the correct handling and representation of the Submission (Subn) property.
- testConvertWithMultipleNoteProperties: Explains the test's goal of verifying the correct handling and representation of multiple note properties.
- testConvertWithHeadProperty: Describes the test's purpose of verifying the correct inclusion and formatting of the Header (Head) property.

These changes ensure that future developers and maintainers have a clear understanding of the test suite's structure and purpose, facilitating easier updates, debugging, and enhancements.

liberu-genealogy / php-gedcom

Add Docstrings to tests/WriterTest.php #26

PR Feedback (click)

I created this PR to address this rule:

Description

Summary of Changes

Rollback Files For Sweep