[Sweep Rules] Add docstrings to functions and file headers in src/Writer.php - Githubissues

liberu-genealogy / php-gedcom

Gedcom reading and writing for PHP 8.3

https://www.liberu.co.uk

MIT License

74 stars 39 forks source link

[Sweep Rules] Add docstrings to functions and file headers in src/Writer.php #30

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 the functions and file headers in the src/Writer.php file of the php-gedcom repository. It addresses the issue #ISSUE_NUMBER by adding docstrings to the following functions: convertHead, convertSubn, convertSubms, convertSours, convertIndis, convertFams, convertNotes, convertRepos, and convertObjes. Additionally, a file header comment has been added to explain the purpose of the file.

Summary of Changes

Added a file header comment to src/Writer.php explaining the purpose of the file.
Added docstrings to the convertHead, convertSubn, convertSubms, convertSours, convertIndis, convertFams, convertNotes, convertRepos, and convertObjes functions in src/Writer.php.

Please review and merge this PR. Thank you!

sweep-ai[bot] commented 6 months ago

Rollback Files For Sweep

[ ] Rollback changes to src/Writer.php
[ ] Rollback changes to src/Writer.php