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

Missing deprecation documentation #3306

Closed
tskj opened this issue Sep 17, 2024 · 5 comments
Closed

Missing deprecation documentation #3306

tskj opened this issue Sep 17, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@tskj
Copy link

tskj commented Sep 17, 2024

Description

In reference to this issue which you prematurely closed and locked #3304.

I appreciate your claim that it's because of third party plugin such as Mason that a user like me is not seeing the error message. However, it is also therefore that I ask that this deprecation be documented so that such a user can find that information! Good documenation and careful engineering is necessary for good software.

I would highly implore you to take backwards compatibility seriously and not break people's setups without proper documentation, even if they happen to use what you call "third party" plugins.

@tskj tskj added the bug Something isn't working label Sep 17, 2024
@glepnir
Copy link
Member

glepnir commented Sep 17, 2024

@tskj I don't understand what you are saying? lspconfig has always been compatible. We provided a deprecation message? You can't see the message because you use third plugin? Why don't you file an issue there?

@justinmk
Copy link
Member

Send a PR.

@justinmk justinmk added documentation Improvements or additions to documentation and removed bug Something isn't working labels Sep 17, 2024
@glepnir
Copy link
Member

glepnir commented Sep 17, 2024

and tsserver still works even lspconfig through a deprecate message. if you don't get it works please check what that plugin do.

@tskj
Copy link
Author

tskj commented Sep 17, 2024

Yes it's compatible because you aliased it, which I very much appreciate! That's a good practice. I'm saying you should also document this decision somewhere.

Send a PR.

Sure, here, I tried my hand at some documenting: #3307. Feel free to reword it or move however you see fit. I also suggest your project have a deprecation / change history somewhere for people to look at, which I haven't included in this PR. Not sure exactly how that would look, but it would be the correct way to handle breaking backwards compatibility.

@justinmk
Copy link
Member

After #3308 LspInfo now shows a "deprecated servers" message.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants