When I sent a pullik to OSS to modify the document, it was rejected, but I didn't understand the content of the reply.Below is the URL and its reply.
https://github.com/symfony/symfony/pull/35730
Reply:
We never add phpdocs that do not add anything that is not already part of the method signature.
Google Translation:
Do not add phpdocs that are not part of the method signature
What was wrong with me?Please let me know.
php english oss symfony
It's a triple denial, so it's hard to understand even if it's translated into Japanese, but if you change the expression a little, you'll say, "I won't add phpdocs that only contain information already in the signature."
The purpose is to keep the header doc principle (although Japanese projects are often not followed) that information that can be found in signatures (method names, argument names, argument types) should not be written in the header doc.
This post was edited based on @Ooper's Comment and posted as Community Wiki.This post was edited based on @Ooper's Comment and posted as Community Wiki.
© 2024 OneMinuteCode. All rights reserved.