Add docstrings to public methods #2
Merged
Conversation
This file contains hidden or 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
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).
…lemetryStreamVehicle` classes * **TeslemetryStream Class** - Add section explaining all public methods with brief descriptions. * **TeslemetryStreamVehicle Class** - Add section explaining all public methods except `listen_*` methods. - List `listen_*` methods with their callback types.
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.
Add documentation for public methods in
TeslemetryStreamandTeslemetryStreamVehicleclasses.README.md
TeslemetryStreamclass.TeslemetryStreamVehicleclass.teslemetry_stream/stream.py
TeslemetryStreamclass, including__init__,get_vehicle,connected,get_config,find_server,update_fields,replace_fields,config,connect,close,__aiter__,__anext__,async_add_listener,listen,listen_Credits, andlisten_Balance.recursive_matchfunction.For more details, open the Copilot Workspace session.