Add Docstrings to Functions in GedcomExporterTest.php and ImporterTests.php - Githubissues

liberu-genealogy / laravel-gedcom

Gedcom reading and writing for Laravel 11

https://www.liberu.co.uk

MIT License

77 stars 50 forks source link

Add Docstrings to Functions in GedcomExporterTest.php and ImporterTests.php #25

Closed sweep-ai[bot] closed 6 months ago

sweep-ai[bot] commented 6 months ago

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 adds docstrings to several functions in GedcomExporterTest.php and ImporterTests.php as requested in the issue. The docstrings provide a clear description of each function's purpose, its inputs, and its outputs, following the project's docstring style guide.

The following functions now have docstrings:

setupExportTestEnvironment in GedcomExporterTest.php
verifyExportedFileExists in GedcomExporterTest.php
prepareMockDataForNoteImport in ImporterTests.php
verifyNoteImportResult in ImporterTests.php
verifyObjeImportResult in ImporterTests.php

Summary of Changes

Added a docstring to setupExportTestEnvironment function in GedcomExporterTest.php
Added a docstring to verifyExportedFileExists function in GedcomExporterTest.php
Added a docstring to prepareMockDataForNoteImport function in ImporterTests.php
Added a docstring to verifyNoteImportResult function in ImporterTests.php
Added a docstring to verifyObjeImportResult function in ImporterTests.php

These changes improve the readability and consistency of the codebase, making it easier for other developers to understand the purpose and functionality of these functions.

sweep-ai[bot] commented 6 months ago

Rollback Files For Sweep

[ ] Rollback changes to tests/Unit/GedcomExporterTest.php
[ ] Rollback changes to tests/Unit/GedcomExporterTest.php
[ ] Rollback changes to tests/Unit/GedcomExporterTest.php
[ ] Rollback changes to tests/Unit/GedcomExporterTest.php
[ ] Rollback changes to tests/Unit/ImporterTests.php
[ ] Rollback changes to tests/Unit/ImporterTests.php
[ ] Rollback changes to tests/Unit/ImporterTests.php
[ ] Rollback changes to tests/Unit/ImporterTests.php
[ ] Rollback changes to tests/Unit/ImporterTests.php
[ ] Rollback changes to tests/Unit/ImporterTests.php