Clarify LSP scope and Python-specific nature in README#11
Merged
Conversation
The README described the LSP as "EnergyPlus language support," but idfkit-lsp registers only .py -> python and serves Python code that imports idfkit, not the IDF/epJSON language. Reword the entry and add a caveat that the server attaches to every .py file and may compete with the user's primary Python LSP. Closes #4 https://claude.ai/code/session_01BYBeYVxYHEv2rAC4TK9F8S
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated the README to clarify that
idfkit-lspis a language server for Python code that imports idfkit, not an IDF/epJSON language server. Added a note explaining its scope, registration behavior, and potential conflicts with other Python LSPs.Changes
idfkit-lsp)"idfkit-lsptargets Python code that imports idfkit, not IDF/epJSON files.pyfiles and attaches to all Python files in the projectDetails
This clarification helps users understand the actual scope and limitations of the LSP implementation, preventing confusion about its capabilities and managing expectations around LSP conflicts in multi-LSP environments.
https://claude.ai/code/session_01BYBeYVxYHEv2rAC4TK9F8S