[11.x] Simplify PHP comments #6316
Merged
+31
−97
Conversation
This file contains hidden or 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
|
Took it a bit further and deleted all comments from routes files and integrated your previous scheduler simplification suggestion. |
Respectfully, I didn't appreciate the comments being removed. Laravel stops being friendly to newbies, like me, when a file is left without any explanation as to why it exists. The fact that it is absolutely simple makes it difficult to understand its function. It is precisely in this situation that comments are most useful. |
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.
Hi everyone! This pull request proposes a small change the PHP comments in our skeleton. They've been around for a while, and we're all pretty used to them. But, I'm curious about your thoughts on reshaping our docs to align more with the style used in "laravel/framework:" (and in any other repository really), while simultaneously do the three-character rule.
Here is an example:
Not that, I am not fully convinced; however, if this pull request gets merged, I will go around to the other repositories and adjust the PHP comments accordingly via PR.