Skip to content

[ty] Add documentation for server traits #19137

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jul 7, 2025
Merged

[ty] Add documentation for server traits #19137

merged 3 commits into from
Jul 7, 2025

Conversation

dhruvmanila
Copy link
Member

This PR adds some basic documentation for the traits in the server implementation.

@dhruvmanila dhruvmanila added the internal An internal refactor or improvement label Jul 4, 2025
@dhruvmanila dhruvmanila requested review from BurntSushi and removed request for dcreager, carljm, sharkdp and AlexWaygood July 4, 2025 03:51
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 4, 2025 •
edited
Loading

mypy_primer results

Changes were detected when running on open source projects 
hydra-zen (https://github.com/mit-ll-responsible-ai/hydra-zen)
- TOTAL MEMORY USAGE: ~88MB
+ TOTAL MEMORY USAGE: ~97MB

colour (https://github.com/colour-science/colour)
- TOTAL MEMORY USAGE: ~405MB
+ TOTAL MEMORY USAGE: ~445MB

pytest (https://github.com/pytest-dev/pytest)
- TOTAL MEMORY USAGE: ~276MB
+ TOTAL MEMORY USAGE: ~251MB

scrapy (https://github.com/scrapy/scrapy)
-     memo fields = ~207MB
+     memo fields = ~189MB

bokeh (https://github.com/bokeh/bokeh)
- TOTAL MEMORY USAGE: ~276MB
+ TOTAL MEMORY USAGE: ~251MB

aiohttp (https://github.com/aio-libs/aiohttp)
-     memo fields = ~129MB
+     memo fields = ~117MB

openlibrary (https://github.com/internetarchive/openlibrary)
-     memo fields = ~171MB
+     memo fields = ~189MB

scipy (https://github.com/scipy/scipy)
- TOTAL MEMORY USAGE: ~1399MB
+ TOTAL MEMORY USAGE: ~1271MB

manticore (https://github.com/trailofbits/manticore)
-     memo fields = ~652MB
+     memo fields = ~593MB

@dylwil3 dylwil3 added the ty Multi-file analysis & type inference label Jul 4, 2025
MichaReiser
MichaReiser approved these changes Jul 7, 2025
View reviewed changes
Copy link
Member

@MichaReiser MichaReiser left a comment

Choose a reason for hiding this comment

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

This is great. Thank you

MichaReiser
MichaReiser reviewed Jul 7, 2025
View reviewed changes
@dhruvmanila dhruvmanila force-pushed the dhruv/server-trait-doc branch from 97b0b39 to 98324bd Compare July 7, 2025 14:22
@dhruvmanila dhruvmanila enabled auto-merge (squash) July 7, 2025 14:23
@dhruvmanila dhruvmanila added documentation Improvements or additions to documentation server Related to the LSP server and removed ty Multi-file analysis & type inference documentation Improvements or additions to documentation labels Jul 7, 2025
@dhruvmanila dhruvmanila merged commit 56258bb into main Jul 7, 2025
33 checks passed
@dhruvmanila dhruvmanila deleted the dhruv/server-trait-doc branch July 7, 2025 14:26
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 7, 2025

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

AlexWaygood pushed a commit that referenced this pull request Jul 7, 2025
@dhruvmanila @AlexWaygood
[ty] Add documentation for server traits (#19137)
dfaa095 
This PR adds some basic documentation for the traits in the server
implementation.
@AlexWaygood AlexWaygood mentioned this pull request Jul 7, 2025
Open
UnboundVariable pushed a commit to UnboundVariable/ruff that referenced this pull request Jul 7, 2025
Merge branch 'main' of https://github.com/astral-sh/ruff into semanti…
53b6abe 
…c_tokens

* 'main' of https://github.com/astral-sh/ruff: (27 commits)
  [ty] First cut at semantic token provider (astral-sh#19108)
  [`flake8-simplify`] Make example error out-of-the-box (`SIM116`) (astral-sh#19111)
  [`flake8-use-pathlib`] Make example error out-of-the-box (`PTH210`) (astral-sh#19189)
  [`flake8-use-pathlib`] Add autofixes for `PTH203`, `PTH204`, `PTH205` (astral-sh#18922)
  [`flake8-type-checking`] Fix syntax error introduced by fix (`TC008`) (astral-sh#19150)
  [`flake8-pyi`] Make example error out-of-the-box (`PYI007`, `PYI008`) (astral-sh#19103)
  Update Rust crate indicatif to 0.18.0 (astral-sh#19165)
  [ty] Add separate CI job for memory usage stats (astral-sh#19134)
  [ty] Add documentation for server traits (astral-sh#19137)
  Rename to `SessionSnapshot`, move unwind assertion closer (astral-sh#19177)
  [`flake8-type-checking`] Make example error out-of-the-box (`TC001`) (astral-sh#19151)
  [ty] Bare `ClassVar` annotations (astral-sh#15768)
  [ty] Re-enable multithreaded pydantic benchmark (astral-sh#19176)
  [ty] Implement equivalence for protocols with method members (astral-sh#18659)
  [ty] Use RHS inferred type for bare `Final` symbols (astral-sh#19142)
  [ty] Support declaration-only attributes (astral-sh#19048)
  [ty] Sync vendored typeshed stubs (astral-sh#19174)
  Update dependency pyodide to ^0.28.0 (astral-sh#19164)
  Update NPM Development dependencies (astral-sh#19170)
  Update taiki-e/install-action action to v2.56.7 (astral-sh#19169)
  ...
BurntSushi
BurntSushi reviewed Jul 9, 2025
View reviewed changes
Copy link
Member

@BurntSushi BurntSushi left a comment

Choose a reason for hiding this comment

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

Nice, thank you! This is very helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BurntSushi BurntSushi BurntSushi left review comments

@MichaReiser MichaReiser MichaReiser approved these changes

Assignees
No one assigned
Labels
internal An internal refactor or improvement server Related to the LSP server
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dhruvmanila @BurntSushi @MichaReiser @dylwil3