python: improve documentation #254
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
mguida22
reviewed
Feb 28, 2025
|
|
||
| .. py:class:: Bytes(value: bytes) | ||
|
|
||
| A byte array |
There was a problem hiding this comment.
Should this match the description In _foglove_py/__init__.pyi?
Suggested change
| A byte array | |
| A byte array, encoded as a base64-encoded string. |
There was a problem hiding this comment.
Good catch. It's the other way around; the python implementation does the encoding for you. I've updated.
There was a problem hiding this comment.
Ah I see, in that case I think this is just missing a period.
mguida22
approved these changes
Feb 28, 2025
|
|
||
| .. py:class:: Bytes(value: bytes) | ||
|
|
||
| A byte array |
There was a problem hiding this comment.
Ah I see, in that case I think this is just missing a period.
gasmith
approved these changes
Feb 28, 2025
Comment on lines
190
to
192
| :param host: The host to bind to. | ||
| :type host: Optional[str] | ||
| :param port: The port to bind to. |
There was a problem hiding this comment.
We should add the default values here.
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.
This improves the python documentation & example; notably:
For the first two items, I resorted to manual documentation for the reasons noted in index.rst. This is unfortunate, and I think we're going to need to look into some sort of doc testing down the line, but it's better than missing documentation today.