-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
build(psalm): Configure unstable namespace #49224
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: provokateurin <[email protected]>
c9fb8f6
to
72571a1
Compare
} | ||
} | ||
|
||
private static function checkMethodOrConstantComment(Stmt $stmt, FileSource $statementsSource, string $type): void { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing check for since
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For NCU we only want to check @experimental
and not @since
.
If the API is moved to OCP it is not compatible anyway due to the namespace change (even if everything else stays the same), so that's the point when the @since
annotations need to be added and the @experimental
annotations need to be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need the since to be able to remember the 1 release until decision and 2 releases until removal?
https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/api.html
An API can only live in this unstable namespace for one major release.
…
Deprecated API from the NCU namespace are kept for 2 major releases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought we'd add @experimental 31.0.0
to indicate the version it lives in the namespace.
@ArtificialOwl maybe you can shed some more light on how this should work, the documentation doesn't seem to be clear enough about this (please also update it if necessary).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As you are saying, having @since
while in unstable might be confusing, and we can follow the implementation version via @experimental
Summary
@experimental
and not@since
Checklist