HTTP: Remove redundant doc comments from Response implementations#920
Merged
HTTP: Remove redundant doc comments from Response implementations#920
Conversation
As per https://stackoverflow.com/a/26554272 and https://docs.phpdoc.org/guide/guides/inheritance.html, phpDocumentor will inherit the doc comments from the interface. Keeping them in implementation is thus mostly pointless noise. The only benefit is that the docs are immediately available even when not using an IDE or LSP but keeping them in sync is too annoying to be worth it.
Art4
approved these changes
Jun 27, 2025
Contributor
Art4
left a comment
Art4
left a comment
There was a problem hiding this comment.
Thanks for the clarification. 👍
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As per https://stackoverflow.com/a/26554272 and https://docs.phpdoc.org/guide/guides/inheritance.html, phpDocumentor will inherit the doc comments from the interface. Keeping them in implementation is thus mostly pointless noise. The only benefit is that the docs are immediately available even when not using an IDE or LSP but keeping them in sync is too annoying to be worth it.