Rename hover API to doc API (#18)

* Initial plan

* Rename hover API to doc API - update Python code and schema files

Co-authored-by: observerw <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: observerw <[email protected]>

Author: Copilot

schema/HoverRequest.json schema/DocRequest.jsonschema/HoverRequest.json renamed to schema/DocRequest.json

@@ -100,6 +100,6 @@
   "required": [
     "locate"
   ],
-  "title": "HoverRequest",
+  "title": "DocRequest",
   "type": "object"
 }

schema/hover.response.json schema/DocResponse.jsonschema/hover.response.json renamed to schema/DocResponse.json

@@ -1,5 +1,5 @@
 {
-  "markdown": "\n# Hover Information\n\n{{ content }}\n",
+  "markdown": "\n# Doc Information\n\n{{ content }}\n",
   "properties": {
     "content": {
       "title": "Content",
@@ -9,6 +9,6 @@
   "required": [
     "content"
   ],
-  "title": "HoverResponse",
+  "title": "DocResponse",
   "type": "object"
 }

schema/hover.md schema/doc.mdschema/hover.md renamed to schema/doc.md

@@ -1,6 +1,6 @@
-# Hover API
+# Doc API
 
-The Hover API provides quick access to documentation, type information, or other
+The Doc API provides quick access to documentation, type information, or other
 relevant metadata for a symbol at a specific location. It's useful for getting
 context without navigating to the definition.
 
@@ -32,7 +32,7 @@ Request:
 }
 ```
 
-### Scenario 3: Getting hover for a class method
+### Scenario 3: Getting documentation for a class method
 
 Request:
 
@@ -47,7 +47,7 @@ Request:
 }
 ```
 
-### Scenario 4: Getting hover for an imported module
+### Scenario 4: Getting documentation for an imported module
 
 Request:
 
@@ -62,5 +62,5 @@ Request:
 
 ## References
 
-- [HoverRequest.json](./HoverRequest.json)
-- [HoverResponse.json](./HoverResponse.json)
+- [DocRequest.json](./DocRequest.json)
+- [DocResponse.json](./DocResponse.json)

schema/hover.request.json schema/doc.request.jsonschema/hover.request.json renamed to schema/doc.request.json

@@ -100,6 +100,6 @@
   "required": [
     "locate"
   ],
-  "title": "HoverRequest",
+  "title": "DocRequest",
   "type": "object"
 }

schema/HoverResponse.json schema/doc.response.jsonschema/HoverResponse.json renamed to schema/doc.response.json

@@ -1,5 +1,5 @@
 {
-  "markdown": "\n# Hover Information\n\n{{ content }}\n",
+  "markdown": "\n# Doc Information\n\n{{ content }}\n",
   "properties": {
     "content": {
       "title": "Content",
@@ -9,6 +9,6 @@
   "required": [
     "content"
   ],
-  "title": "HoverResponse",
+  "title": "DocResponse",
   "type": "object"
 }

src/lsap/capability/__init__.py

@@ -1,7 +1,7 @@
 from typing import TypedDict
 
 from .definition import DefinitionCapability
-from .hover import HoverCapability
+from .doc import DocCapability
 from .locate import LocateCapability
 from .outline import OutlineCapability
 from .reference import ReferenceCapability
@@ -12,7 +12,7 @@
 
 class Capabilities(TypedDict):
     definition: DefinitionCapability
-    hover: HoverCapability
+    doc: DocCapability
     locate: LocateCapability
     outline: OutlineCapability
     references: ReferenceCapability

src/lsap/capability/hover.py src/lsap/capability/doc.pysrc/lsap/capability/hover.py renamed to src/lsap/capability/doc.py

@@ -5,20 +5,20 @@
 from attrs import define
 from lsp_client.capability.request import WithRequestHover
 
-from lsap.schema.hover import HoverRequest, HoverResponse
+from lsap.schema.doc import DocRequest, DocResponse
 from lsap.utils.capability import ensure_capability
 
 from .abc import Capability
 from .locate import LocateCapability
 
 
 @define
-class HoverCapability(Capability[HoverRequest, HoverResponse]):
+class DocCapability(Capability[DocRequest, DocResponse]):
     @cached_property
     def locate(self) -> LocateCapability:
         return LocateCapability(self.client)
 
-    async def __call__(self, req: HoverRequest) -> HoverResponse | None:
+    async def __call__(self, req: DocRequest) -> DocResponse | None:
         if not (loc_resp := await self.locate(req)):
             return None
 
@@ -30,4 +30,4 @@ async def __call__(self, req: HoverRequest) -> HoverResponse | None:
         if hover is None:
             return None
 
-        return HoverResponse(content=hover.value)
+        return DocResponse(content=hover.value)

src/lsap/schema/hover.py src/lsap/schema/doc.pysrc/lsap/schema/hover.py renamed to src/lsap/schema/doc.py

@@ -1,7 +1,7 @@
 """
-# Hover API
+# Doc API
 
-The Hover API provides quick access to documentation, type information, or other
+The Doc API provides quick access to documentation, type information, or other
 relevant metadata for a symbol at a specific location. It's useful for getting
 context without navigating to the definition.
 
@@ -33,7 +33,7 @@
 }
 ```
 
-### Scenario 3: Getting hover for a class method
+### Scenario 3: Getting documentation for a class method
 
 Request:
 
@@ -48,7 +48,7 @@
 }
 ```
 
-### Scenario 4: Getting hover for an imported module
+### Scenario 4: Getting documentation for an imported module
 
 Request:
 
@@ -70,7 +70,7 @@
 from .locate import LocateRequest
 
 
-class HoverRequest(LocateRequest):
+class DocRequest(LocateRequest):
     """
     Retrieves documentation or type information for a symbol at a specific location.
 
@@ -80,15 +80,15 @@ class HoverRequest(LocateRequest):
 
 
 markdown_template: Final = """
-# Hover Information
+# Doc Information
 
 {{ content }}
 """
 
 
-class HoverResponse(Response):
+class DocResponse(Response):
     content: str
-    """The hover content, usually markdown."""
+    """The documentation content, usually markdown."""
 
     model_config = ConfigDict(
         json_schema_extra={
@@ -98,6 +98,6 @@ class HoverResponse(Response):
 
 
 __all__ = [
-    "HoverRequest",
-    "HoverResponse",
+    "DocRequest",
+    "DocResponse",
 ]

tests/test_hover.py tests/test_doc.pytests/test_hover.py renamed to tests/test_doc.py

@@ -6,12 +6,12 @@
 from lsprotocol.types import MarkupContent, MarkupKind
 from lsprotocol.types import Position as LSPPosition
 
-from lsap.capability.hover import HoverCapability
-from lsap.schema.hover import HoverRequest
+from lsap.capability.doc import DocCapability
+from lsap.schema.doc import DocRequest
 from lsap.schema.locate import LineScope, Locate
 
 
-class MockHoverClient(MagicMock):
+class MockDocClient(MagicMock):
     def __init__(self, *args, **kwargs):
         class MockProtocols(WithRequestHover, WithRequestDocumentSymbol):
             pass
@@ -39,11 +39,11 @@ async def request_document_symbol_list(self, file_path: Path):
 
 
 @pytest.mark.asyncio
-async def test_hover():
-    client = MockHoverClient()
-    capability = HoverCapability(client=client)  # type: ignore
+async def test_doc():
+    client = MockDocClient()
+    capability = DocCapability(client=client)  # type: ignore
 
-    req = HoverRequest(
+    req = DocRequest(
         locate=Locate(file_path=Path("main.py"), scope=LineScope(line=1), find="foo"),
     )
 
@@ -53,11 +53,11 @@ async def test_hover():
 
 
 @pytest.mark.asyncio
-async def test_hover_not_found():
-    client = MockHoverClient()
-    capability = HoverCapability(client=client)  # type: ignore
+async def test_doc_not_found():
+    client = MockDocClient()
+    capability = DocCapability(client=client)  # type: ignore
 
-    req = HoverRequest(
+    req = DocRequest(
         locate=Locate(file_path=Path("main.py"), scope=LineScope(line=1), find="bar"),
     )