Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Comments to Model Files #1294

Closed
wants to merge 2 commits into from
Closed

Conversation

Ryan-Holden
Copy link

My team and I added comments to several files that had very few comments or none at all. We made no changes to the code itself. Commented files:
Baikal/Model/AddressBook.php
Baikal/Model/Calendar.php
Baikal/Model/User.php
BaikalAdmin/Core/View.php
BaikalAdmin/Framework.php

The comments are meant to clarify the purpose of functions that previously had no documentation. They will help new developers understand the code and begin contributing to the project. Any suggestions or improvements to our comments are welcome.

@ByteHamster
Copy link
Member

Thanks for your PR. To be honest, I'm not sure if this is a good idea. Most of the comments basically just restate the method name, so they don't really give additional knowledge. At the same time, adding these comments increases maintenance overhead (because the comments need to be maintained and because this change touching files all over the project makes it harder to use git blame)

@ByteHamster ByteHamster closed this Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants