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

Fix type doc blocks in annotation classes #10145

Merged
merged 1 commit into from
Oct 17, 2022

Conversation

derrabus
Copy link
Member

@derrabus derrabus commented Oct 17, 2022

In 3.0, I'd like to flag all public properties of our annotation classes as readonly. Since we always use them as is they were immutable, this is the reasonable thing to do imho.

This PR prepares this change by adding a @readonly annotation to all dock blocks. I've also fixed a few other inconsistencies.

@derrabus derrabus added this to the 2.14.0 milestone Oct 17, 2022
Copy link
Member

@greg0ire greg0ire left a comment

Choose a reason for hiding this comment

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

Potential improvement: define new psalm-type for string unions such as 'LAZY'|'EAGER'|"EXTRA_LAZY'

@derrabus
Copy link
Member Author

Yeah, or make that an enum. 🤔

@derrabus derrabus merged commit 1ad936a into doctrine:2.14.x Oct 17, 2022
@derrabus derrabus deleted the types/annotations-backports branch October 17, 2022 20:20
derrabus added a commit to derrabus/orm that referenced this pull request Oct 17, 2022
* 2.14.x:
  Modernize documentation code
  Add CI jobs for SQLite3 driver (doctrine#10141)
  Fix type doc blocks in annotation classes (doctrine#10145)
  Fix FieldMapping for generated key (doctrine#10144)
  Stop triggering static analysis workflows on tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants