Mention non-support for VSCodium in README #1322
Conversation
rogermparent
changed the title
|
Code Climate has analyzed commit e38b87d and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (85% is the threshold). This pull request will bring the total coverage in the repository to 96.3% (0.0% change). View more on Code Climate. |
README.md
Outdated
|
|
||
| ## VSCode Forks | ||
|
|
||
| While the DVC Extension can work with VSCode forks like |
There was a problem hiding this comment.
[C] We do have some other mentions of VSCode in the repo but I think that VS Code is actually correct. See https://code.visualstudio.com/.
README.md
Outdated
| [VSCodium](https://vscodium.com/), our team only supports the official Microsoft | ||
| build and it's possible that issues can arise. The Python extension in | ||
| particular has problems with VSCodium, and often causes our extension's | ||
| integration with it to fail. |
There was a problem hiding this comment.
[F] This is not a show stopper as users can still "setup the workspace" and everything will still work:
There was a problem hiding this comment.
Setup the workspace is the second step in the walkthrough:
I'll admit it is a bit niche, but on a few Linux distros the default install of code in the package manager is VSCodium and the user actually has to go slightly out of their way to install MS VS Code, so it's completely possible for a user to end up in this state without taking extra power user steps (beyond the amount that one would be running Linux and DVC). When installing the Python extension in VSCodium, the parts that don't work are automatically omitted and a limited set of features (mostly virtual environments) "just work". Good point that even if the user's in the situation of DVC in a venv they can manually set up the workspace, I'll modify the text. My main concern in that this is a silent error so if a user does encounter it, our extension will mysteriously fail even though the Python extension looks like it's working fine outside of the console. |
That would not be enough for a normal Python user. Imagine IntelliSense not working for JavaScript in your IDE, you'd either fix it or move to another IDE. |
|
Fair point, I'll close this and keep the case in mind if we ever run into it when public release comes around. |
This PR mentions in the README that we do not suppport VSCodium, and that it has known issues with the Python extension that we integrate with.
Fixes #1318