Commit 63035d8
committed
Add docstrings to public methods
Add documentation for public methods in `TeslemetryStream` and `TeslemetryStreamVehicle` classes.
* **README.md**
- Add a section listing all public methods in the `TeslemetryStream` class.
- Add a section listing all public methods in the `TeslemetryStreamVehicle` class.
* **teslemetry_stream/stream.py**
- Add docstrings to all public methods in the `TeslemetryStream` class, including `__init__`, `get_vehicle`, `connected`, `get_config`, `find_server`, `update_fields`, `replace_fields`, `config`, `connect`, `close`, `__aiter__`, `__anext__`, `async_add_listener`, `listen`, `listen_Credits`, and `listen_Balance`.
- Add docstring to the `recursive_match` function.
---
For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Teslemetry/python-teslemetry-stream?shareId=XXXX-XXXX-XXXX-XXXX).1 parent 3fa7720 commit 63035d8
0 commit comments