Skip to content

Rename @Draft to @ProtocolDraft#928

Merged
pisv merged 1 commit intoeclipse-lsp4j:mainfrom
pisv:rename-draft
Nov 22, 2025
Merged

Rename @Draft to @ProtocolDraft#928
pisv merged 1 commit intoeclipse-lsp4j:mainfrom
pisv:rename-draft

Conversation

@pisv
Copy link
Contributor

@pisv pisv commented Nov 21, 2025

Renames the @Draft annotation to @ProtocolDraft for the sake of consistency with @ProtocolDeprecated and to reserve the @Draft annotation for LSP4J's own API.

Renames the `@Draft` annotation to `@ProtocolDraft`
for the sake of consistency with `@ProtocolDeprecated`
and to reserve the `@Draft` annotation for LSP4J's own API.
@pisv pisv requested a review from jonahgraham November 21, 2025 13:31
Copy link
Contributor

@jonahgraham jonahgraham left a comment

Choose a reason for hiding this comment

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

I do like the symmetry with @ProtocolDeprecated - if someone wants to do @ProtocolSince one day I would be in favour, although I doubt it is worth the effort. The documentation we provided in LSP4J for DAP/LSP is more of a courtesy to Java developers using the library and not a substitute for the official specs.

* in a draft state. Therefore it is subject to incompatible changes (including even removal)
* in a future release.
*
* An API using this annotation is part of an upcoming Protocol Specification and in a draft state.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for generalizing the language here.

@pisv
Copy link
Contributor Author

pisv commented Nov 22, 2025

@jonahgraham Thank you for your review! I also thought about introducing @ProtocolSince, it looks like a logical follow-up. Let's see if I can find the time to do it before 1.0.0. If not, it can be introduced at any later time.

@pisv pisv merged commit e44353e into eclipse-lsp4j:main Nov 22, 2025
6 checks passed
@pisv pisv deleted the rename-draft branch November 22, 2025 10:20
@jonahgraham jonahgraham added this to the 1.0.0 milestone Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants