Rename client objects #359
Merged
Conversation
This file contains 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
alcarney
force-pushed
the
refactor-client
branch
3 times, most recently
from
d953f9d
to
d2095b0
Compare
This should better reflect its purpose as it doesn't do anything by itself. Also the `generate_client.py` script now references all lsp types via `types.X` removing the need for 100s of `from lsprotocol.types import X` statements.
alcarney
force-pushed
the
refactor-client
branch
from
d2095b0
to
1991049
Compare
alcarney
force-pushed
the
refactor-client
branch
from
2333761
to
a1e1e14
Compare
|
@tombh would it be possible to relax commit body length lint? |
|
Sure! Those are just the defaults anyway. |
This updates the documentation to include API documentation for the `JsonRPCClient` and `BaseLanguageClient` using autodoc. By hooking into the `autodoc-process-docstring` event we can rewrite the docstrings of the autogenerated methods so that they conform with reStructuredText syntax and link to the relevant locations. This also adds a custom `:lsp:` role to the documentation which can be used to link to sections of the LSP specification.
Tweak the autogenerated client so that the first line of each method's docstring links to the relevant part of the LSP specification. Reformat the `JsonRPCClient` example code so that it renders correctly in Sphinx
|
This looks good, actually I mean great, some really nice changes. Let's merge this then? |
|
Yes, sounds good :) |
tombh
approved these changes
Aug 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description (e.g. "Related to ...", etc.)
This renames the new client objects to something that better reflects their purpose.
pygls/client.py,Clientis now calledJsonRPCClientLanguageClientinpygls/lsp/client.pyis now calledBaseLanguageClientThis PR also performs some other house keeping tasks
lsprotocolto2023.0.0a3which should include all the fixes required for Initial support for notebook document sync methods #356typesmodule rather than importing them directly which cuts out the 100s of lines of imports at the top of the fileJsonRPCClientandBaseLanguageClientCode review checklist (for code reviewer to complete)