doc: update examples

Author: observerw

examples/pyrefly.py

@@ -17,21 +17,24 @@
 
 async def main():
     # Initialize Pyrefly client with local server
+    # if `workspace` not specified, defaults to current working directory
     async with PyreflyClient(server=PyreflyLocalServer()) as client:
-        # Request references to PyreflyClient at line 21, column 19
+        # Request references to PyreflyClient at line 22, column 20
         refs = await client.request_references(
             file_path="src/lsp_client/clients/pyrefly.py",
             position=Position(21, 19),
-            include_declaration=False,  # Don't include the declaration itself
+            # some requests may support additional options,
+            # e.g. this one excludes the declaration itself from results
+            include_declaration=False,
         )
 
-        if not refs:
-            print("No references found.")
-            return
+        assert refs, "No references found."
 
-        # Print all found references
         for ref in refs:
-            print(f"Reference found at {ref.uri} - Range: {ref.range}")
+            # LSP Server always returns URI instead of file paths
+            # So we need to convert it back to file path using `from_uri`
+            file_path = client.from_uri(ref.uri)
+            print(f"Reference found at {file_path} - Range: {ref.range}")
 
         # Verify that this example file contains a reference to PyreflyClient
         # This demonstrates the reference finding functionality works correctly
@@ -44,8 +47,7 @@ async def main():
             )
             for ref in refs
         )
-        print("Reference assertion passed.")
 
 
 if __name__ == "__main__":
-    anyio.run(main)  # Run the async example
+    anyio.run(main)

examples/pyright_docker.py

@@ -18,9 +18,10 @@ async def main():
     # Set up workspace directory and mount it in Docker
     workspace = Path.cwd()
     async with PyrightClient(
+        # here we use `PyrightDockerServer`
         server=PyrightDockerServer(
-            mounts=[workspace]
-        ),  # Mount workspace into container
+            mounts=[workspace]  # Mount workspace into container
+        ),
         workspace=workspace,
     ) as client:
         # Find definition of PyrightDockerServer at line 12, column 28