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

Don't required since tag in OCP for inherited docs #38810

Conversation

provokateurin
Copy link
Member

Summary

This allows to override methods and classes without having to specify the since tag again. It will be inherited from the parent method or class because the whole doc is inherited. The parent method or class doesn't need to be checked when the inherited doc is encountered, because it will already get checked by the same checker.

Checklist

Copy link
Contributor

@kesselb kesselb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good change 👍

@ChristophWurst
Copy link
Member

This allows to override methods and classes without having to specify the since tag again.

Do you have an example?

@provokateurin
Copy link
Member Author

provokateurin commented Jun 14, 2023

@ChristophWurst 8b1d849 from #38802

@ChristophWurst
Copy link
Member

Shouldn't it be {@inheritDoc}? https://docs.phpdoc.org/guide/guides/inheritance.html

@provokateurin
Copy link
Member Author

The {@ and } parts are automatically removed, but the casing of the tags is not touched. A lot of methods in OCP use the lowercase inheritdoc which I assume to work. Might be worth fixing separately

@provokateurin
Copy link
Member Author

https://docs.phpdoc.org/guide/guides/inheritance.html

Oh that page says the since tag is not inherited :/
Well then this PR is useless.

@ChristophWurst ChristophWurst deleted the fix/psalm-ocp-dont-require-since-for-inherited-doc branch June 14, 2023 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants