Added Comments to Model Files #1294
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.